arcserver.rb 0.1.2 → 0.1.3

data/Rakefile

@@ -1,62 +1,52 @@
-require 'rubygems'
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'fileutils'
+require 'arcserver/version'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "arcserver.rb"
-    gem.summary = %Q{Library for accessing ESRI ArcServer REST and SOAP APIs.}
-    gem.email = "casey.colin@gmail.com"
-    gem.homepage = "http://github.com/colincasey/arcserver.rb"
-    gem.authors = ["Colin Casey"]
-    gem.add_dependency('httparty', '>= 0.4.5')
-    gem.add_dependency('handsoap', '>= 1.1.0')
-    gem.add_dependency('nokogiri', '>= 1.3.3')
-    gem.add_dependency('httpclient', '>= 2.1.5')
-    gem.add_development_dependency('jeweler', '>= 1.2.1')
-    gem.add_development_dependency('shoulda', '>= 2.10.2')
-    gem.add_development_dependency('mocha', '>= 0.9.8')
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+desc "Run all tests"
+task :test => ["test:unit", "test:functional"]
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+task :default => :test
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+namespace :test do
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/unit/**/*_test.rb'
     test.verbose = true
   end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+
+  desc "Run functional tests"
+  Rake::TestTask.new(:functional) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/functional/**/*_test.rb'
+    test.verbose = true
   end
 end
 
-
-task :default => :test
-
-require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "arcserver.rb #{version}"
+  rdoc.title = "arcserver.rb #{ArcServer::VERSION}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+desc "Build arcserver.rb gem"
+task :build do
+  system "gem build arcserver.rb.gemspec"
+
+  base_dir = File.dirname(__FILE__)
+  pkg_dir = File.join(base_dir, "pkg")
+  FileUtils.mkdir_p pkg_dir
+
+  gem_file_name = File.join(base_dir, "arcserver.rb-#{ArcServer::VERSION}.gem")
+  FileUtils.mv(gem_file_name, pkg_dir)
+end
+
+desc "Release arcserver.rb gem"
+task :release => :build do
+  system "gem push pkg/arcserver.rb-#{ArcServer::VERSION}"
+end
+

data/lib/arcserver.rb

@@ -4,4 +4,4 @@ require 'handsoap'
 Handsoap.http_driver = :httpclient
 
 require 'arcserver/url_helper'
-require 'arcserver/map_server'
+require 'arcserver/map_server'

data/lib/arcserver/map_server.rb

@@ -1,15 +1,18 @@
 # encoding: utf-8
 require 'arcserver/rest/map_server'
 require 'arcserver/soap/map_server'
+require 'arcserver/util/legend_image'
 require 'forwardable'
 
 module ArcServer
+  class ArcServerError < StandardError; end
+
   class MapServer
     include UrlHelper
     extend  Forwardable
 
     attr_reader    :soap_service
-    def_delegators :soap_service, :get_default_map_name, :get_legend_info
+    def_delegators :soap_service, :get_default_map_name, :get_legend_info, :get_legend_image
     
     attr_reader    :rest_service
     def_delegators :rest_service, :export
@@ -20,5 +23,18 @@ module ArcServer
       @soap_service = opts[:soap_service] || SOAP::MapServer.new(to_soap(url))
       @rest_service = opts[:rest_service] || REST::MapServer.new(to_rest(url))
     end
+
+    # Utility method for generating a legend image
+    # (requires optional dependency, RMagick [>= 2.13.1], to be installed)
+    #
+    # @return [Magick::Image] the legend as an RMagick Image object
+    def get_legend_image
+       begin
+         require 'RMagick' unless Object.const_defined?("Magick")
+       rescue LoadError
+         raise ArcServerError, "#{self.class}#get_legend_image needs an optional dependency 'RMagick [>= 2.13.1]' to be installed - try `gem install rmagick`"
+       end
+       Util::LegendImage.new(self).get_image
+    end
   end
 end

data/lib/arcserver/soap/map_server.rb

@@ -24,7 +24,6 @@ module ArcServer
 
       def get_legend_info(args = {})
         image_return_type = args[:image_return_url] ? "esriImageReturnURL" : "esriImageReturnMimeData"
-
         response = invoke("ns:GetLegendInfo") do |message|
           message.add "MapName", args[:map_name] || get_default_map_name
           message.add "ImageType" do |image_type|
@@ -85,6 +84,7 @@ module ArcServer
           }
         }
       end
+      
 
     end
   end

data/lib/arcserver/util/legend_image.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module ArcServer
+  module Util
+    class LegendImage
+      DEFAULT_LEGEND_WIDTH = 250
+
+      def initialize(map_server)
+        @map_server = map_server
+      end
+		
+      def get_image	      					      	
+        legend_image = Magick::Image.new(*determine_legend_size)
+
+        gc = Magick::Draw.new
+        gc.stroke_antialias(false)
+        gc.text_antialias = false
+        gc.density = "96x96"
+			
+        y = 0
+        legend_info.each do |legend|
+          name = legend[:name]          
+          gc.text(10, y+=30, name)
+
+          gc.draw(legend_image)
+          y -= 15
+
+          legend_classes = legend[:legend_groups][0][:legend_classes]
+          legend_classes.each do |legend_class|
+            img = Magick::Image.read_inline(legend_class[:symbol_image][:image_data]).first
+            legend_image.composite!(img, 20, y+=25, Magick::OverCompositeOp)
+            gc.text(50, y+14, legend_class[:label]) unless legend_class[:label].nil?
+            gc.draw(legend_image)
+            img.destroy!
+          end
+
+          y += 5
+        end
+
+        legend_image
+	  	end
+		  	
+	  	private
+  		def determine_legend_size	  		
+	    	width = DEFAULT_LEGEND_WIDTH
+
+        height = legend_info.inject(0) do  |h, legend|
+          legend_classes = legend[:legend_groups][0][:legend_classes]
+
+          # expand the legend width if labels are present
+          legend_classes.each do |legend_class|
+            if label = legend_class[:label]
+              label_width = label.length * 10
+              width = width > label_width ? width : label_width
+            end
+          end
+
+          h += (20 + (25 * legend_classes.length))
+        end
+
+        [width, height + 20]
+	    end
+
+      def legend_info
+        @legend_info ||= @map_server.get_legend_info
+      end
+    end
+  end
+end

data/lib/arcserver/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module ArcServer
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 3
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/test/test_helper.rb

@@ -9,4 +9,17 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'arcserver'
 
 class Test::Unit::TestCase 
+  @@fixtures = {}
+  def self.fixtures list
+    [list].flatten.each do |fixture|
+      self.class_eval do
+        # add a method name for this fixture type
+        define_method(fixture) do |item|
+          # load and cache the YAML
+          @@fixtures[fixture] ||= YAML::load_file("test/fixtures/#{fixture.to_s}.yml")
+          @@fixtures[fixture][item.to_s]
+        end
+      end
+    end
+  end
 end    

data/test/unit/map_server_test.rb

@@ -40,4 +40,22 @@ class ArcServer::MapServerTest < Test::Unit::TestCase
       @map_server.export
     end
   end
+
+  context "verify delegation of legend image creation to ArcServer::Util::LegendImage" do
+    setup do
+      @map_server = ArcServer::MapServer.new('http://sampleserver1.arcgisonline.com/ArcGIS/services/Demographics/ESRI_Census_USA/MapServer')
+    end
+
+    should "fail if optional dependency RMagick is not installed" do
+      Object.expects(:const_defined?).with("Magick").returns(false)
+      @map_server.expects(:require).with('RMagick').raises(LoadError)
+      assert_raise(ArcServer::ArcServerError) { @map_server.get_legend_image }
+    end
+
+    should "forward get_legend_image to LegendImage" do
+      mock_legend_image = mock { expects(:get_image) }
+      ArcServer::Util::LegendImage.expects(:new).with(@map_server).returns(mock_legend_image)
+      @map_server.get_legend_image
+    end
+  end  
 end

data/test/unit/util/legend_image_test.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../test_helper'
+require 'RMagick'
+
+class ArcServer::Util::LegendImageTest < Test::Unit::TestCase
+  should "raise an error if nothing supplied to constructor" do
+    assert_raise(ArgumentError) { ArcServer::Util::LegendImage.new }
+  end
+
+  context "with third party libraries mocked out" do
+    setup do
+      legend_info = test_legend_info
+      map_server = mock('map_server') { stubs(:get_legend_info).returns(legend_info) }
+      @legend = ArcServer::Util::LegendImage.new(map_server)
+
+      mock_symbol_image = mock('symbol_image') do
+        expects(:first).times(3).returns(self)
+        expects(:destroy!).times(3)
+      end
+      Magick::Image.expects(:read_inline).with("AAA").returns(mock_symbol_image)
+      Magick::Image.expects(:read_inline).with("BBB").returns(mock_symbol_image)
+      Magick::Image.expects(:read_inline).with("CCC").returns(mock_symbol_image)
+
+      mock_image = mock('image') do
+        stubs(:cur_image)
+        expects(:composite!).with(mock_symbol_image, 20, 40, Magick::OverCompositeOp)
+        expects(:composite!).with(mock_symbol_image, 20, 65, Magick::OverCompositeOp)
+        expects(:composite!).with(mock_symbol_image, 20, 110, Magick::OverCompositeOp)
+      end
+      Magick::Image.expects(:new).returns(mock_image)      
+
+      mock_draw = mock('draw') do
+        stubs(:draw)
+        stubs(:stroke_antialias)
+        stubs(:text_antialias=)
+        stubs(:density=)
+        expects(:text).with(10, 30, "Legend 1")
+        expects(:text).with(50, 54, "Symbol 1")
+        expects(:text).with(50, 79, "Symbol 2")
+        expects(:text).with(10, 100, "Legend 2")
+      end
+      Magick::Draw.expects(:new).returns(mock_draw)
+
+    end
+
+    should "be able to retrieve legend image" do
+      @legend.get_image
+    end
+  end
+
+  def test_legend_info
+    [{
+      :name => "Legend 1",
+      :legend_groups => [
+        :legend_classes => [
+          { :label => "Symbol 1", :symbol_image => { :image_data => "AAA" } },
+          { :label => "Symbol 2", :symbol_image => { :image_data => "BBB" } }
+        ]
+      ]
+    }, {
+      :name => "Legend 2",
+      :legend_groups => [
+        :legend_classes => [
+          { :symbol_image => { :image_data => "CCC" } }
+        ]
+      ]
+    }]
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: arcserver.rb
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Colin Casey
@@ -9,81 +14,117 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-13 00:00:00 -03:00
+date: 2010-08-18 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 5
         version: 0.4.5
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: handsoap
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
         version: 1.3.3
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: httpclient
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 5
         version: 2.1.5
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.1
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 2
         version: 2.10.2
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
         version: 0.9.8
-    version: 
-description: 
-email: casey.colin@gmail.com
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 13
+        - 1
+        version: 2.13.1
+  type: :development
+  version_requirements: *id007
+description: arcserver.rb is a utility for accessing ESRI ArcServer REST and SOAP APIs from a unified interface
+email: 
+- casey.colin@gmail.com
 executables: []
 
 extensions: []
@@ -92,21 +133,21 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- arcserver.rb.gemspec
-- lib/arcserver.rb
 - lib/arcserver/map_server.rb
 - lib/arcserver/rest/map_server.rb
 - lib/arcserver/soap/map_server.rb
 - lib/arcserver/url_helper.rb
+- lib/arcserver/util/legend_image.rb
+- lib/arcserver/version.rb
+- lib/arcserver.rb
+- LICENSE
+- README.rdoc
+- Rakefile
 - test/functional/soap/map_server_test.rb
 - test/test_helper.rb
 - test/unit/map_server_test.rb
 - test/unit/url_helper_test.rb
+- test/unit/util/legend_image_test.rb
 has_rdoc: true
 homepage: http://github.com/colincasey/arcserver.rb
 licenses: []
@@ -117,26 +158,31 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Library for accessing ESRI ArcServer REST and SOAP APIs.
 test_files: 
-- test/test_helper.rb
 - test/functional/soap/map_server_test.rb
-- test/unit/url_helper_test.rb
+- test/test_helper.rb
 - test/unit/map_server_test.rb
+- test/unit/url_helper_test.rb
+- test/unit/util/legend_image_test.rb

data/.gitignore

@@ -1,6 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg
-nbproject

data/VERSION

@@ -1 +0,0 @@
-0.1.2

data/arcserver.rb.gemspec

@@ -1,77 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{arcserver.rb}
-  s.version = "0.1.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Colin Casey"]
-  s.date = %q{2009-10-13}
-  s.email = %q{casey.colin@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "arcserver.rb.gemspec",
-     "lib/arcserver.rb",
-     "lib/arcserver/map_server.rb",
-     "lib/arcserver/rest/map_server.rb",
-     "lib/arcserver/soap/map_server.rb",
-     "lib/arcserver/url_helper.rb",
-     "test/functional/soap/map_server_test.rb",
-     "test/test_helper.rb",
-     "test/unit/map_server_test.rb",
-     "test/unit/url_helper_test.rb"
-  ]
-  s.homepage = %q{http://github.com/colincasey/arcserver.rb}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
-  s.summary = %q{Library for accessing ESRI ArcServer REST and SOAP APIs.}
-  s.test_files = [
-    "test/test_helper.rb",
-     "test/functional/soap/map_server_test.rb",
-     "test/unit/url_helper_test.rb",
-     "test/unit/map_server_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0.4.5"])
-      s.add_runtime_dependency(%q<handsoap>, [">= 1.1.0"])
-      s.add_runtime_dependency(%q<nokogiri>, [">= 1.3.3"])
-      s.add_runtime_dependency(%q<httpclient>, [">= 2.1.5"])
-      s.add_development_dependency(%q<jeweler>, [">= 1.2.1"])
-      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
-      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
-    else
-      s.add_dependency(%q<httparty>, [">= 0.4.5"])
-      s.add_dependency(%q<handsoap>, [">= 1.1.0"])
-      s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
-      s.add_dependency(%q<httpclient>, [">= 2.1.5"])
-      s.add_dependency(%q<jeweler>, [">= 1.2.1"])
-      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
-      s.add_dependency(%q<mocha>, [">= 0.9.8"])
-    end
-  else
-    s.add_dependency(%q<httparty>, [">= 0.4.5"])
-    s.add_dependency(%q<handsoap>, [">= 1.1.0"])
-    s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
-    s.add_dependency(%q<httpclient>, [">= 2.1.5"])
-    s.add_dependency(%q<jeweler>, [">= 1.2.1"])
-    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
-    s.add_dependency(%q<mocha>, [">= 0.9.8"])
-  end
-end