bicho 0.0.4 → 0.0.5

data/lib/bicho/bug.rb

@@ -80,7 +80,7 @@ module Bicho
     # URL where the bug can be viewed
     # Example: http://bugs.foo.com/2345
     def url
-      "#{@client.url}/#{id}"
+      "#{@client.site_url}/#{id}"
     end
 
   end

data/lib/bicho/client.rb

@@ -62,15 +62,40 @@ module Bicho
 
     include Bicho::Logging
 
-    attr_reader :url, :userid
+    # @return [URI] XML-RPC API end-point
+    #
+    # This URL is automatically inferred from the
+    # Client#site_url
+    #
+    # Plugins can modify the inferred value by providing
+    # a transform_api_url_hook(url, logger) method returning
+    # the modified value.
+    #
+    attr_reader :api_url
 
-    def initialize(url)
-      # Don't modify the original url
-      url = url.is_a?(URI) ? url.clone : URI.parse(url) 
-      # save the unmodified (by plugins) url
-      @original_url = url.clone
+    # @return [URI] Bugzilla installation website
+    #
+    # This value is provided at construction time
+    attr_reader :site_url
+
+    # @return [String] user id, available after login
+    attr_reader :userid
+
+    # @visibility private
+    # Implemented only to warn users about the replacement
+    # APIs
+    def url
+      warn "url is deprecated. Use site_url or api_url"
+      raise NoMethodError
+    end
 
-      url.path = '/xmlrpc.cgi'
+    # @param [String] site_url Bugzilla installation site url
+    def initialize(site_url)
+      # Don't modify the original url
+      @site_url = site_url.is_a?(URI) ? site_url.clone : URI.parse(site_url) 
+      
+      @api_url = @site_url.clone
+      @api_url.path = '/xmlrpc.cgi'
 
       # Scan plugins
       plugin_glob = File.join(File.dirname(__FILE__), 'plugins', '*.rb')
@@ -84,10 +109,14 @@ module Bicho
         pl_class = ::Bicho::Plugins.const_get(cnt)
         pl_instance = pl_class.new
         logger.debug("Loaded: #{pl_instance}")
-        pl_instance.initialize_hook(url, logger)
+
+        # Modify API url
+        if pl_instance.respond_to?(:transform_api_url_hook)
+          @api_url = pl_instance.transform_api_url_hook(@api_url, logger)
+        end
       end
 
-      @client = XMLRPC::Client.new_from_uri(url.to_s, nil, 900)
+      @client = XMLRPC::Client.new_from_uri(@api_url.to_s, nil, 900)
       @client.set_debug
 
       # User.login sets the credentials cookie for subsequent calls
@@ -96,9 +125,6 @@ module Bicho
         handle_faults(ret)
         @userid = ret['id']
       end
-
-      # Save modified url
-      @url = url
     end
 
     def cookie
@@ -141,7 +167,7 @@ module Bicho
       end
 
       logger.info("Expanding named query: '#{what}' with '#{cookie}'")
-      http = Net::HTTP.new(@url.host, @url.port)
+      http = Net::HTTP.new(@api_url.host, @api_url.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       http.set_debug_output(Bicho::LoggerIODevice.new)

data/lib/bicho/plugins/novell.rb

@@ -58,17 +58,20 @@ module Bicho
         end
       end
 
-      def initialize_hook(url, logger)
-
-        return if not url.host.include?('bugzilla.novell.com')
+      def transform_api_url_hook(url, logger)
+        
+        return url if not url.host.include?('bugzilla.novell.com')
 
         auth = Novell.oscrc_credentials
+        
+        url = url.clone
         url.user = auth[:user]
         url.password = auth[:password]
         url.host = url.host.gsub(/bugzilla\.novell.com/, 'apibugzilla.novell.com')
         url.path = url.path.gsub(/xmlrpc\.cgi/, 'tr_xmlrpc.cgi')
 
         logger.debug("#{self} : Rewrote url to '#{url.to_s.gsub(/#{url.user}:#{url.password}/, "USER:PASS")}'")
+        return url
       end
 
     end

data/lib/bicho/version.rb

@@ -1,3 +1,3 @@
 module Bicho
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/test_novell_plugin.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class NovellPlugin_test < Test::Unit::TestCase
+
+  def test_urls_are_correct
+    client = Bicho::Client.new('https://bugzilla.novell.com')
+
+    assert_raises NoMethodError do
+      client.url
+    end
+
+    assert_equal 'https://apibugzilla.novell.com/tr_xmlrpc.cgi', "#{client.api_url.scheme}://#{client.api_url.host}#{client.api_url.path}"
+    assert_equal 'https://bugzilla.novell.com', "#{client.site_url.scheme}://#{client.site_url.host}#{client.site_url.path}"
+
+  end
+
+end

metadata

@@ -1,68 +1,94 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: bicho
-version: !ruby/object:Gem::Version
-  version: 0.0.4
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
 platform: ruby
-authors:
+authors: 
 - Duncan Mac-Vicar P.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: inifile
-  requirement: &6670800 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
         version: 0.4.1
   type: :runtime
-  prerelease: false
-  version_requirements: *6670800
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: trollop
-  requirement: &6670160 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.16'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 1
+        - 16
+        version: "1.16"
   type: :runtime
-  prerelease: false
-  version_requirements: *6670160
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: highline
-  requirement: &6669600 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
         version: 1.6.2
   type: :runtime
-  prerelease: false
-  version_requirements: *6669600
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &6669180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *6669180
+  version_requirements: *id004
 description: Library to access bugzilla
-email:
+email: 
 - dmacvicar@suse.de
-executables:
+executables: 
 - bicho
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -83,32 +109,43 @@ files:
 - lib/bicho/query.rb
 - lib/bicho/version.rb
 - test/helper.rb
+- test/test_novell_plugin.rb
 - test/test_query.rb
+has_rdoc: true
 homepage: http://github.com/dmacvicar/bicho
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: bicho
-rubygems_version: 1.8.11
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Library to access bugzilla
-test_files:
+test_files: 
 - test/helper.rb
+- test/test_novell_plugin.rb
 - test/test_query.rb
-has_rdoc: