howlingmine-client 0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1 / 2009-10-06
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+examples/issues_example.rb
+howlingmine_client.tmproj
+lib/howlingmine.rb
+lib/howlingmine/client.rb
+lib/howlingmine/config.rb
+lib/howlingmine/issue.rb
+redmine_test_files/database.yml
+redmine_test_files/redmine.db
+test/issue_test.rb

data/README.txt

@@ -0,0 +1,23 @@
+Howling Mine Client
+====================
+
+AR-esque library to interface with Howling Mine Server:
+
+http://github.com/rubiojr/howlingmine-server
+
+Code loosely based on hoptoad notifier by Thoughbot inc.
+http://github.com/thoughtbot/hoptoad_notifier
+
+
+INSTALLATION
+------------
+
+Install the rubygem from http://gemcutter.org
+
+Requires howlingmine-server redmine plugin 0.1
+
+EXAMPLES
+-------------
+see examples/ dir
+
+

data/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/howlingmine.rb'
+
+Hoe.spec 'howlingmine-client' do |p|
+  p.version = HowlingMine::VERSION
+  p.developer('Sergio Rubio', 'sergio@rubio.name')
+  p.summary = 'Client library for the Howling Mine Server'
+  p.description = 'Client library for the Howling Mine Server'
+  p.url = 'http://github.com/rubiojr/howlingmine-client'
+  p.test_globs = ['test/*_test.rb']
+end
+
+# vim: syntax=Ruby
+
+task :restore_redmine_db do
+  FileUtils.cp 'redmine_test_files/redmine.db','/opt/redmine-0.8/db/redmine.db'
+end

data/examples/issues_example.rb

@@ -0,0 +1,38 @@
+require "#{File.join(File.dirname(__FILE__),'../lib/howlingmine.rb')}"
+
+HowlingMine::Config.host = 'redmine.local'
+HowlingMine::Config.port = 80 # default
+HowlingMine::Config.use_ssl = false # default
+HowlingMine::Config.project = 'howlingmine'
+HowlingMine::Config.tracker = 'Bug' # default
+HowlingMine::Config.api_key = 'OPlv8xfQmmEy0x5yHMrX'
+
+HowlingMine::Issue.all.each do |i|
+  puts "-" * 40
+  puts "Issue ID:       #{i.id}"
+  puts "Subject:        #{i.subject}"
+  puts "Created On:     #{i.created_on}"
+  puts "Last update:    #{i.updated_on}"
+  puts "Issue status:   #{i.status}"
+end
+
+issue = HowlingMine::Issue.new
+issue.subject = 'issue number one'
+issue.description = 'oh my, first issue'
+# if an issue with the same subject exist, the default behaviour
+# is to update the journal creating another comment
+issue.save 
+
+# Get redmine issue #1 and update the journal
+issue = HowlingMine::Issue.get 1
+if issue
+  issue.description = 'another journal entry' # adds a comment to the issue
+  issue.save
+end
+
+# Get the last issue and print the last update date
+issue = HowlingMine::Issue.last
+if issue
+  puts '-' * 40
+  puts "Issue ##{issue.id} updated on: #{issue.updated_on.strftime '%F %H:%M'}"
+end

data/howlingmine_client.tmproj

@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>currentDocument</key>
+	<string>test/issue_test.rb</string>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>howlingmine_client</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>200</integer>
+	<key>metaData</key>
+	<dict>
+		<key>README.txt</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>9</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+		</dict>
+		<key>Rakefile</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>0</integer>
+				<key>line</key>
+				<integer>20</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+		</dict>
+		<key>lib/howlingmine/client.rb</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>127</integer>
+				<key>line</key>
+				<integer>22</integer>
+			</dict>
+			<key>columnSelection</key>
+			<false/>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+			<key>selectFrom</key>
+			<dict>
+				<key>column</key>
+				<integer>115</integer>
+				<key>line</key>
+				<integer>22</integer>
+			</dict>
+			<key>selectTo</key>
+			<dict>
+				<key>column</key>
+				<integer>127</integer>
+				<key>line</key>
+				<integer>22</integer>
+			</dict>
+		</dict>
+		<key>lib/howlingmine/config.rb</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>12</integer>
+				<key>line</key>
+				<integer>6</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+		</dict>
+		<key>lib/howlingmine/issue.rb</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>23</integer>
+				<key>line</key>
+				<integer>33</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>48</integer>
+		</dict>
+		<key>test/issue_test.rb</key>
+		<dict>
+			<key>caret</key>
+			<dict>
+				<key>column</key>
+				<integer>30</integer>
+				<key>line</key>
+				<integer>106</integer>
+			</dict>
+			<key>firstVisibleColumn</key>
+			<integer>0</integer>
+			<key>firstVisibleLine</key>
+			<integer>0</integer>
+		</dict>
+	</dict>
+	<key>openDocuments</key>
+	<array>
+		<string>lib/howlingmine/issue.rb</string>
+		<string>test/issue_test.rb</string>
+		<string>Rakefile</string>
+		<string>lib/howlingmine/client.rb</string>
+		<string>README.txt</string>
+		<string>lib/howlingmine/config.rb</string>
+	</array>
+	<key>showFileHierarchyDrawer</key>
+	<true/>
+	<key>windowFrame</key>
+	<string>{{300, 77}, {660, 645}}</string>
+</dict>
+</plist>

data/lib/howlingmine.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'net/https'
+require 'rubygems'
+require 'rest_client'
+require 'pp'
+require 'json'
+require 'time'
+require "#{File.join(File.dirname(__FILE__),'howlingmine/config')}"
+require "#{File.join(File.dirname(__FILE__),'howlingmine/client')}"
+require "#{File.join(File.dirname(__FILE__),'howlingmine/issue')}"
+
+module HowlingMine
+  VERSION = '0.1'
+end

data/lib/howlingmine/client.rb

@@ -0,0 +1,28 @@
+module HowlingMine
+  module Client
+
+    class << self
+      def new_issue
+        post_ticket
+      end
+
+      def post_ticket
+        RestClient.post("#{HowlingMine::Config.protocol}://#{HowlingMine::Config.host}:#{HowlingMine::Config.port}/howling_mine/new_issue", HowlingMine::Config.params.merge(:api_key => HowlingMine::Config.api_key))
+      end
+
+      def issue_status
+        RestClient.post("#{HowlingMine::Config.protocol}://#{HowlingMine::Config.host}:#{HowlingMine::Config.port}/howling_mine/issue_status", :api_key => HowlingMine::Config.api_key, :issue_id => HowlingMine::Config.params[:issue_id])
+      end
+      def issues
+        RestClient.post("#{HowlingMine::Config.protocol}://#{HowlingMine::Config.host}:#{HowlingMine::Config.port}/howling_mine/issues", :api_key => HowlingMine::Config.api_key, :issue_id => HowlingMine::Config.params[:issue_id])
+      end
+      def projects 
+        RestClient.post("#{HowlingMine::Config.protocol}://#{HowlingMine::Config.host}:#{HowlingMine::Config.port}/howling_mine/projects", :api_key => HowlingMine::Config.api_key, :issue_id => HowlingMine::Config.params[:issue_id])
+      end
+      def journals 
+        RestClient.post("#{HowlingMine::Config.protocol}://#{HowlingMine::Config.host}:#{HowlingMine::Config.port}/howling_mine/journals", :api_key => HowlingMine::Config.api_key, :issue_id => HowlingMine::Config.params[:issue_id])
+      end
+    end
+  end
+
+end

data/lib/howlingmine/config.rb

@@ -0,0 +1,62 @@
+module HowlingMine
+  class Config
+    
+    attr_accessor :api_key
+    
+    def self.api_key
+      params[:api_key]
+    end
+    
+    def self.api_key=(k)
+      params[:api_key] = k
+    end
+    
+    def self.params
+      @@params ||= {}
+    end
+    
+    def self.host
+      @@host ||= 'localhost'
+    end
+    
+    def self.host=(h)
+      @@host = h
+    end
+    
+    def self.port=(p)
+      @@port = p
+    end
+    
+    def self.port
+      @@port ||= 80
+    end
+    
+    def self.use_ssl
+      @@use_ssl ||= false
+    end
+    
+    def self.use_ssl=(yn)
+      @@use_ssl ||= yn
+    end
+    
+    def self.project
+      params[:project]
+    end
+    
+    def self.project=(p)
+      params[:project] = p
+    end
+    
+    def self.protocol
+      use_ssl ? 'https' : 'http'
+    end
+    
+    def self.tracker=(t)
+      params[:tracker] = t
+    end
+    
+    def self.tracker
+      params[:tracker] ||= 'Bug'
+    end
+  end
+end

data/lib/howlingmine/issue.rb

@@ -0,0 +1,92 @@
+module HowlingMine
+  class Issue
+  
+    attr_accessor :id, :subject, :description, :raw, :author
+    attr_writer :created_on, :updated_on
+  
+    def save
+      client = HowlingMine::Client
+      params = {
+        :subject => subject || 'no subject',
+        :description => description || '',
+        :author => author || 'none',
+        #:custom_fields => {
+        #  :foofield1 => 'field-text'
+        #}.to_yaml
+      }
+    
+      HowlingMine::Config.params.merge!(params)
+      
+      begin
+        response = client.new_issue
+        @id = response.to_i
+        return true
+      rescue Exception => e
+        return false
+      end
+    end
+  
+    def self.all
+      project = JSON.parse(HowlingMine::Client.projects).find do |p| 
+        p['identifier'] == HowlingMine::Config.project
+      end
+      project_id = ''
+      if ! project.nil?
+        project_id = project['id']
+      else
+        raise Exception.new("#{HowlingMine::Config.project} project not found in target Redmine")
+      end
+      issues = []
+      client = HowlingMine::Client
+      JSON.parse(client.issues).each do |i|
+        next if i['project_id'] != project_id
+        issue = Issue.new
+        issue.subject = i['subject']
+        issue.description = i['description']
+        issue.id = i['id'].to_i
+        issue.raw = i
+        issue.created_on = i['created_on']
+        issue.updated_on = i['updated_on']
+        if i['custom_fields']
+        end
+        issues << issue
+      end
+      issues
+    end
+    
+    def updated_on
+      Time.parse @updated_on
+    end
+  
+    def created_on
+      Time.parse @created_on
+    end
+  
+    def self.first
+      all.first
+    end
+  
+    def self.last
+      all.last
+    end
+  
+    def status
+      c = HowlingMine::Client
+      HowlingMine::Config.params.merge!(:issue_id => id)
+      c.issue_status.downcase
+    end
+  
+    def self.get(ticket_no)
+      all.find do |i| ticket_no.to_i == i.id end
+    end
+  
+    def journal
+      client = HowlingMine::Client
+      params = {
+        :issue_id => id
+      }
+      HowlingMine::Config.params.merge! params
+      JSON.parse(client.journals)
+    end
+  end
+end

data/redmine_test_files/database.yml

@@ -0,0 +1,12 @@
+# MySQL (default setup).  Versions 4.1 and 5.0 are recommended.
+#
+# Get the fast C bindings:
+#   gem install mysql
+#   (on OS X: gem install mysql -- --include=/usr/local/lib)
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+
+production:
+  adapter: sqlite3
+  dbfile: db/redmine.db
+  

data/test/issue_test.rb

@@ -0,0 +1,111 @@
+require 'test/unit'
+require "#{File.join(File.dirname(__FILE__),'../lib/howlingmine.rb')}"
+
+class TestIssue < Test::Unit::TestCase
+
+  def setup
+    FileUtils.cp 'redmine_test_files/redmine.db','/opt/redmine-0.8/db/redmine.db'
+    HowlingMine::Config.host = 'redmine.local'
+    HowlingMine::Config.port = 80 # default
+    HowlingMine::Config.use_ssl = false # default
+    HowlingMine::Config.project = 'howlingmine'
+    HowlingMine::Config.tracker = 'Bug' # default
+    HowlingMine::Config.api_key = 'FboVJFYVg84avd2dfL3Y'
+  end 
+
+  def teardown
+  end
+  
+  def test_api_key
+    HowlingMine::Config.api_key = '0'
+    assert_raises RestClient::RequestFailed do
+      HowlingMine::Issue.all
+    end
+    
+    assert_nothing_raised do
+      HowlingMine::Config.api_key = 'FboVJFYVg84avd2dfL3Y'
+      HowlingMine::Issue.all
+    end
+  end
+  
+  def test_empty_issues
+    assert HowlingMine::Issue.all.empty?
+  end
+  
+  def test_subject
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number one'
+    issue.save
+    issue = HowlingMine::Issue.get 1
+    issue.subject == 'issue number one'
+  end
+  
+  def test_get
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number one'
+    assert issue.save    
+    issue = HowlingMine::Issue.get 1
+    assert ! issue.nil?
+    assert issue.subject == 'issue number one'
+  end
+  
+  def test_new_issue
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number one'
+    assert_nothing_raised do 
+      assert issue.save
+    end
+    
+    assert HowlingMine::Issue.all.size == 1
+    
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number 2'
+    issue.description = 'stuff'
+    assert issue.save
+    assert issue.id == 2
+    assert HowlingMine::Issue.all.size == 2
+  end
+  
+  def test_last_issue
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number one'
+    assert issue.save
+    assert issue.id == HowlingMine::Issue.last.id
+    assert HowlingMine::Issue.last.id == 1
+  end
+  
+  def test_first_issue
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number one'
+    assert issue.save
+    assert issue.id == HowlingMine::Issue.first.id
+    assert HowlingMine::Issue.first.id == 1
+  end
+  
+  def test_journal
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number 1'
+    issue.save
+    assert issue.journal.size == 0
+    issue.description = 'comment one'
+    issue.save
+    assert issue.journal.size == 1    
+  end
+  
+  def test_save
+    issue = HowlingMine::Issue.new
+    issue.subject = 'issue number 1'
+    issue.description = 'description'
+    assert issue.save
+    issue = HowlingMine::Issue.get 1
+    assert issue.subject == 'issue number 1'
+    assert issue.description == 'description'
+    
+    assert_nothing_raised do
+      issue = HowlingMine::Issue.new
+      assert issue.save
+      assert HowlingMine::Issue.all.size == 2
+    end
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: howlingmine-client
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Sergio Rubio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Client library for the Howling Mine Server
+email: 
+- sergio@rubio.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- examples/issues_example.rb
+- howlingmine_client.tmproj
+- lib/howlingmine.rb
+- lib/howlingmine/client.rb
+- lib/howlingmine/config.rb
+- lib/howlingmine/issue.rb
+- redmine_test_files/database.yml
+- redmine_test_files/redmine.db
+- test/issue_test.rb
+has_rdoc: true
+homepage: http://github.com/rubiojr/howlingmine-client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: howlingmine-client
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Client library for the Howling Mine Server
+test_files: 
+- test/issue_test.rb