dm-bugzilla-adapter 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+extra_docs = ['README*', 'TODO*', 'CHANGELOG*']
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << File.expand_path('../test', __FILE__)
+  t.libs << File.expand_path('../', __FILE__)
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+begin
+ require 'yard'
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files   = ['lib/**/*.rb', *extra_docs]
+    t.options = ['--no-private']
+  end
+rescue LoadError
+  STDERR.puts "Install yard if you want prettier docs"
+  require 'rdoc/task'
+  Rake::RDocTask.new(:doc) do |rdoc|
+    rdoc.rdoc_dir = "doc"
+    rdoc.title = "dm-bugzilla-adapter #{DataMapper::Adapters::BugzillaAdapter::VERSION}"
+    extra_docs.each { |ex| rdoc.rdoc_files.include ex }
+  end
+end

data/dm-bugzilla-adapter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dm-bugzilla-adapter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dm-bugzilla-adapter"
+  s.version     = DataMapper::Adapters::BugzillaAdapter::VERSION
+
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Klaus Kämpf"]
+  s.email       = ["kkaempf@suse.de"]
+  s.homepage    = ""
+  s.summary     = %q{A datamapper adapter for Bugzilla (aka bugzilla.novell.com)}
+  s.description = %q{Use it in Ruby applications to access Bugzilla}
+
+  s.add_dependency("bicho", ["~> 0.0.2"])
+  s.add_dependency("nokogiri", ["~> 1.4"])
+  
+  s.rubyforge_project = "dm-bugzilla-adapter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/bugzilla/bug.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'dm-core'
+class Bug
+  include DataMapper::Resource
+
+  belongs_to :named_query, :required => false
+
+  property :id, Integer, :key => true    #  id [Integer] The numeric id of the bug.
+  property :status, String               #  status [String] The current status of a bug (not including its resolution, if it has one, which is a separate field above).
+  property :severity, String             #  severity [String] The Severity field on a bug.
+  property :priority, String             #  priority [String] The Priority field on a bug.
+  property :product, String              #  product [String] The name of the Product that the bug is in.
+  property :component, String            #  component [String] The name of the Component that the bug is in.
+  property :assigned_to, String          #  assigned_to [String] The login name of a user that a bug is assigned to.
+  property :version, String              #  version [String] The Version field of a bug.
+  property :target_milestone, String     #  target_milestone [String] The Target Milestone field of a bug. Note that even if this Bugzilla does not have the Target Milestone field enabled, you can still search for bugs by Target Milestone. However, it is likely that in that case, most bugs will not have a Target Milestone set (it defaults to "---" when the field isn't enabled).
+  property :summary, String              #  summary [String] Searches for substrings in the single-line Summary field on bugs. If you specify an array, then bugs whose summaries match any of the passed substrings will be returned.
+  property :creation_time, DateTime      # Searches for bugs that were created at this time or later. May not be an array.
+  property :creator, String              # The login name of the user who created the bug.
+  property :last_change_time, DateTime   # Searches for bugs that were modified at this time or later. May not be an array.
+  property :op_sys, String               # The "Operating System" field of a bug.
+  property :platform, String             # The Platform (sometimes called "Hardware") field of a bug.
+  property :creator, String              # The login name of the user who reported the bug.
+  property :resolution, String           # The current resolution--only set if a bug is closed. You can find open bugs by searching for bugs with an empty resolution.    
+  property :qa_contact, String           # The login name of the bug's QA Contact. Note that even if this Bugzilla does not have the QA Contact field enabled, you can still search for bugs by QA Contact (though it is likely that no bug will have a QA Contact set, if the field is disabled).
+  property :url, String                  # The "URL" field of a bug.
+  property :whiteboard, String           # Search the "Status Whiteboard" field on bugs for a substring. Works the same as the summary field described above, but searches the Status Whiteboard field.
+
+end

data/lib/bugzilla/named_query.rb

@@ -0,0 +1,13 @@
+#
+# named_query.rb
+#
+# A named query in Bugzilla
+#
+require 'rubygems'
+require 'dm-core'
+
+class NamedQuery
+  include DataMapper::Resource
+  property :name, String, :key => true
+  has n, :bugs
+end

data/lib/dm-bugzilla-adapter.rb

@@ -0,0 +1,71 @@
+#
+# dm-bugzilla-adapter.rb
+#
+require 'rubygems'
+
+# DataMapper
+require 'dm-core'
+require 'dm-core/adapters/abstract_adapter'
+
+# bugzilla xmlrpc
+require "bicho"
+
+# bugzilla https
+require 'net/https'
+require 'nokogiri'
+
+# dm-bugzilla-adapter modules
+require "dm-bugzilla-adapter/create"
+require "dm-bugzilla-adapter/read"
+require "dm-bugzilla-adapter/update"
+require "dm-bugzilla-adapter/delete"
+require "dm-bugzilla-adapter/misc"
+
+module DataMapper
+  class Property
+    autoload :XML, "property/xml"
+  end
+end
+
+
+module DataMapper::Adapters
+  
+  class BugzillaAdapter < AbstractAdapter
+
+    # @api public
+    def initialize(name, options)
+      super
+      require 'uri'
+      @uri = URI.parse(options[:url])
+      @client = Bicho::Client.new(@uri)
+    end
+
+    # get Bugs by ids
+    def get_bugs(ids)
+      bugs = @client.get_bugs(*ids)
+    end
+    
+    # run named query, return Array of bug ids
+    def named_query(name)
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Get.new("/buglist.cgi?cmdtype=runnamed&namedcmd=#{name}&ctype=atom", { "Cookie" => @client.cookie } )
+      response = http.request(request)
+      case response
+      when Net::HTTPSuccess
+	bugs = []
+	xml = Nokogiri::XML.parse(response.body)
+	xml.root.xpath("//xmlns:entry/xmlns:link/@href", xml.root.namespace).each do |attr|
+	  uri = URI.parse attr.value
+	  bugs << uri.query.split("=")[1]
+	end
+	get_bugs(bugs)
+      when Net::HTTPRedirect
+	raise "HTTP redirect not supported in named_query"
+      else
+	response.error!
+      end
+    end
+  end
+end

data/lib/dm-bugzilla-adapter/create.rb

@@ -0,0 +1,22 @@
+# create.rb
+module DataMapper::Adapters
+class BugzillaAdapter < AbstractAdapter
+  def create(resources)
+    STDERR.puts "BugzillaAdapter::create"
+    table_groups = group_resources_by_table(resources)
+    table_groups.each do |table, resources|
+      # make
+      #  class User
+      #    property :id, Serial
+      #  end
+      # work
+      resources.each do |resource|
+	initialize_serial(resource,
+			  worksheet_record_cound(table)+1)
+	post_resource_to_worksheet(resource,table)
+      end
+    end
+    resources.size
+  end
+end
+end

data/lib/dm-bugzilla-adapter/delete.rb

@@ -0,0 +1,22 @@
+# delete.rb
+module DataMapper::Adapters
+class BugzillaAdapter < AbstractAdapter
+  # Constructs and executes DELETE statement for given query
+  #
+  # @param [Collection] collection
+  #   collection of records to be deleted
+  #
+  # @return [Integer]
+  #   the number of records deleted
+  #
+  # @api semipublic
+							
+  def delete(collection)
+    each_resource_with_edit_url(collection) do |resource, edit_url|
+      connection.delete(edit_url, 'If-Match' => "*")
+    end
+    # return count
+    collection.size
+  end
+end
+end

data/lib/dm-bugzilla-adapter/misc.rb

@@ -0,0 +1,9 @@
+# misc.rb
+module DataMapper::Adapters
+class BugzillaAdapter < AbstractAdapter
+  # Auto-migration
+  # DataMapper.auto_migrate!
+  # or
+  # DataMapper.auto_update!
+end
+end

data/lib/dm-bugzilla-adapter/read.rb

@@ -0,0 +1,176 @@
+# read.rb
+module DataMapper::Adapters
+  class BugzillaAdapter < AbstractAdapter
+    require 'bugzilla/bug'
+    require 'bugzilla/named_query'
+    ##
+    # Retrieves records for a particular model.
+    #
+    # @param [DataMapper::Query] query
+    #   The query used to locate the resources
+    #
+    # @return [Array]
+    #   An array of hashes of all of the records for a particular model
+    #
+    # @api semipublic
+    def read(query)
+#      STDERR.puts "BugzillaAdapter::read"
+#     fields = query.fields
+#      STDERR.puts "fields #{fields.inspect}"
+#      types  = fields.map { |property| property.primitive }
+#      STDERR.puts "types #{types.inspect}"
+      records = records_for(query)
+#      query.filter_records(records)
+    end
+
+  private
+    # taken from https://github.com/whoahbot/dm-redis-adapter/
+    
+    def records_for(query)
+#      STDERR.puts "records_for(#{query})"
+#      STDERR.puts "records_for(#{query.inspect})"
+      records = []
+      if query.conditions.nil?
+	raise "query.conditions.nil?" # FIXME
+      else
+	query.conditions.operands.each do |operand|
+	  if operand.is_a?(DataMapper::Query::Conditions::OrOperation)
+	    operand.each do |op|
+	      records = records + perform_query(query, op)
+	    end
+	  else
+	    records = perform_query(query, operand)
+	  end
+	end
+      end      
+      records
+    end #def
+
+    ##
+    # Find records that match have a matching value
+    #
+    # @param [DataMapper::Query] query
+    #   The query used to locate the resources
+    #
+    # @param [DataMapper::Operation] the operation for the query
+    #
+    # @return [Array]
+    #   An array of hashes of all of the records for a particular model
+    #
+    # @api private
+    def perform_query(query, operand)
+#      STDERR.puts "perform_query(q '#{query}', op '#{operand}')"
+      records = []
+		    
+      if operand.is_a?(DataMapper::Query::Conditions::NotOperation)
+#	STDERR.puts "operand is a NOT operation"
+	subject = operand.first.subject
+	value = operand.first.value
+      elsif operand.subject.is_a?(DataMapper::Associations::ManyToOne::Relationship)
+#	STDERR.puts "operand subject is a many-to-one relation: '#{operand.subject.inspect}'"
+	if operand.subject.parent_model == NamedQuery && operand.subject.child_model == Bug
+	  name = operand.value[operand.subject.parent_key.first.name]
+	  bugs = named_query(name)
+	  bugs.each do |bug|
+	    records << bug_to_record(query.model, bug)
+	  end
+	  return records
+	else
+	  raise "Unknown parent (#{operand.subject.parent_model}) child (#{operand.subject.child_model}) relation"
+	end
+      else
+#	STDERR.puts "operand is normal"
+	subject = operand.subject
+	value =  operand.value
+      end
+      
+      if subject.is_a?(DataMapper::Associations::ManyToOne::Relationship)
+#	STDERR.puts "subject is a many-to-one relation"
+	subject = subject.child_key.first
+      end
+      
+      # typical queries
+      #
+      
+#      STDERR.puts "perform_query(subject '#{subject.inspect}', value '#{value.inspect}')"
+      case query.model.name
+      when "Bug"
+	if query.model.key.include?(subject)
+	  # get single <bug>
+	  bugs = get_bugs(value)
+	  records << bug_to_record(query.model, bugs.first)
+	else
+	  raise "Unknown query for bug"
+	end
+      when "NamedQuery"
+	records << { subject.name.to_s => value }
+	# be lazy: do the actual named query when NamedQuery#bugs gets accessed
+      else
+	raise "Unsupported model '#{query.model.name}'"
+      end
+      
+      records
+    end # def
+
+    ##
+    # Convert Bicho::Bug into record (as hash of key/value pairs)
+    #
+    # @return [Hash]
+    #   A hash of all of the properties for a particular record
+    #
+    #  assigned_to [String] The login name of a user that a bug is assigned to.
+    #  component [String] The name of the Component that the bug is in.
+    #  creation_time [DateTime] Searches for bugs that were created at this time or later. May not be an array.
+    #  creator [String] The login name of the user who created the bug.
+    #  id [Integer] The numeric id of the bug.
+    #  last_change_time [DateTime] Searches for bugs that were modified at this time or later. May not be an array.
+    #  limit [Integer] Limit the number of results returned to int records.
+    #  offset [Integer] Used in conjunction with the limit argument, offset defines the starting position for the search. For example, given a search that would return 100 bugs, setting limit to 10 and offset to 10 would return bugs 11 through 20 from the set of 100.
+    #  op_sys [String] The "Operating System" field of a bug.
+    #  platform [String] The Platform (sometimes called "Hardware") field of a bug.
+    #  priority [String] The Priority field on a bug.
+    #  product [String] The name of the Product that the bug is in.
+    #  creator [String] The login name of the user who reported the bug.
+    #  resolution [String] The current resolution--only set if a bug is closed. You can find open bugs by searching for bugs with an empty resolution.
+    #  severity [String] The Severity field on a bug.
+    #  status [String] The current status of a bug (not including its resolution, if it has one, which is a separate field above).
+    #  summary [String] Searches for substrings in the single-line Summary field on bugs. If you specify an array, then bugs whose summaries match any of the passed substrings will be returned.
+    #  target_milestone [String] The Target Milestone field of a bug. Note that even if this Bugzilla does not have the Target Milestone field enabled, you can still search for bugs by Target Milestone. However, it is likely that in that case, most bugs will not have a Target Milestone set (it defaults to "---" when the field isn't enabled).
+    #  qa_contact [String] The login name of the bug's QA Contact. Note that even if this Bugzilla does not have the QA Contact field enabled, you can still search for bugs by QA Contact (though it is likely that no bug will have a QA Contact set, if the field is disabled).
+    #  url [String] The "URL" field of a bug.
+    #  version [String] The Version field of a bug.
+    #  whiteboard [String] Search the "Status Whiteboard" field on bugs for a substring. Works the same as the summary field described above, but searches the Status Whiteboard field.
+    #
+    # @api private
+    def bug_to_record(model, bug)
+#      STDERR.puts "bug_to_record #{bug.inspect}"
+      record = { }
+      model.properties.each do |p|
+	v = case p.name
+      when :version, :target_milestone, :op_sys, :qa_contact : bug['internals', p.name]
+      when :platform : bug['internals', 'rep_platform']
+      when :creator : bug['internals', 'reporter_id']
+      when :whiteboard : bug['internals', 'status_whiteboard']
+	else
+	  bug[p.name]
+	end
+#	STDERR.puts "#{v.inspect} -> #{p.inspect}"
+	if v
+	  case p
+	  when DataMapper::Property::String:   v = v.to_s
+	  when DataMapper::Property::Integer:  v = v.to_i
+	  when DataMapper::Property::DateTime
+#	    STDERR.puts "DateTime #{v.to_a.inspect}"
+	    v = DateTime.civil(*v.to_a)
+#	    STDERR.puts "DateTime #{v}"
+	  else
+	    raise "*** Unsupported property type #{p.inspect}"
+	  end
+	end
+	record[p.name.to_s] = v
+      end
+      record
+    end
+    
+  end # class
+end # module

data/lib/dm-bugzilla-adapter/update.rb

@@ -0,0 +1,24 @@
+# update.rb
+module DataMapper::Adapters
+class BugzillaAdapter < AbstractAdapter
+  # Constructs and executes UPDATE statement for given
+  # attributes and a query
+  #
+  # @param [Hash(Property => Object)] attributes
+  #   hash of attribute values to set, keyed by Property
+  # @param [Collection] collection
+  #   collection of records to be updated
+  #
+  # @return [Integer]
+  #   the number of records updated
+  #
+  # @api semipublic
+  def update(attributes, collection)
+    each_resource_with_edit_url(collection) do |resource, edit_url|
+      put_updated_resource(edit_url, resource)
+    end
+    # return count
+    collection.size
+  end
+end
+end

data/lib/dm-bugzilla-adapter/version.rb

@@ -0,0 +1,8 @@
+require 'dm-core'
+require 'dm-core/adapters/abstract_adapter'
+
+module DataMapper::Adapters
+  class BugzillaAdapter < AbstractAdapter
+    VERSION = "0.0.1"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'dm-bugzilla-adapter'
+
+if ENV["DEBUG"]
+  Bicho::Logging.logger = Logger.new(STDERR)
+  Bicho::Logging.logger.level = Logger::DEBUG
+end

data/test/test_get_bug.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class Get_bug_test < Test::Unit::TestCase
+
+  def test_get_bug
+    DataMapper::Logger.new(STDOUT, :debug)
+    keeper = DataMapper.setup(:default,
+			      :adapter => 'bugzilla',
+			      :url  => 'https://bugzilla.novell.com')
+
+    require 'bugzilla/bug'
+    DataMapper.finalize
+
+    bug = Bug.get(424242)
+    assert bug
+    puts "Bug #{bug.inspect}"
+  end
+
+end

data/test/test_run_named_query.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class Run_named_query_test < Test::Unit::TestCase
+
+  def test_run_named_query
+    DataMapper::Logger.new(STDOUT, :debug)
+    keeper = DataMapper.setup(:default,
+			      :adapter => 'bugzilla',
+			      :url  => 'https://bugzilla.novell.com')
+
+    require 'bugzilla/named_query'
+    DataMapper.finalize
+
+    named_query = NamedQuery.get("Manager")
+    assert named_query
+    bugs = named_query.bugs
+    assert bugs
+    puts "Query '#{named_query.name}' results in #{bugs.size} bugs"
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: dm-bugzilla-adapter
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Klaus K\xC3\xA4mpf"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bicho
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id002
+description: Use it in Ruby applications to access Bugzilla
+email: 
+- kkaempf@suse.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- dm-bugzilla-adapter.gemspec
+- lib/bugzilla/bug.rb
+- lib/bugzilla/named_query.rb
+- lib/dm-bugzilla-adapter.rb
+- lib/dm-bugzilla-adapter/create.rb
+- lib/dm-bugzilla-adapter/delete.rb
+- lib/dm-bugzilla-adapter/misc.rb
+- lib/dm-bugzilla-adapter/read.rb
+- lib/dm-bugzilla-adapter/update.rb
+- lib/dm-bugzilla-adapter/version.rb
+- test/helper.rb
+- test/test_get_bug.rb
+- test/test_run_named_query.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: dm-bugzilla-adapter
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A datamapper adapter for Bugzilla (aka bugzilla.novell.com)
+test_files: 
+- test/helper.rb
+- test/test_get_bug.rb
+- test/test_run_named_query.rb