omnifocus-redmine 1.1.0 → 1.2.0

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.2.0 / 2011-02-15
+* Fixed a bug with a missing variable
+* Removed an errant puts
+* Added support for authentication
+
 === 1.1.0 / 2011-02-8
 * Added ability to run multiple queries.
 

data/README.txt

@@ -6,21 +6,33 @@
 
 Plugin for the omnifocus gem to provide synchronization with Redmine Issues.
 
+This plugin uses the Redmine REST API. It must be enabled by an administrator
+for the plugin to work.  
+
 The first time this runs it creates a yaml file in your home directory for 
-the redmine url and username.
+the configuration data.
+
+ * redmine_url is required. This is the base url for the redmine repository.
+
+ * user_id is required. To find your user id login and go to the my account
+   page. Your user_id is the number at the end of the url for my account.
 
-The queries config is optional.  If it is not included omnifocus-redmine will
-pull all open bugs assigned to the specified user.
+ * username is optional. It is used if the redmine server requires 
+   authentication.  
 
-To use a custom query or multiple queries you must include a queries parameter
-in your config.
+ * password is optional. It is used if the redmine server requires 
+   authentication.  
 
-The queries config is an array of strings.  These strings will be appended onto a
-query of the form: http://your-redmine-url/issues.xml?assigned_to_id=user-id?.
+ * queries is optional. It is used for custom queries or multiple queries. 
+   The queries config is an array of strings.  The strings will be appended 
+   to a query of the form: 
+      "http://redmine_url/issues.xml?assigned_to_id=user_id".
 
 Example:
 :user_id: 20
 :redmine_url: http://redmine/
+:username: me
+:password: 1234
 :queries: ["status_id=1", "status_id=2"]
 
 == FEATURES/PROBLEMS:

data/lib/omnifocus/redmine.rb

@@ -1,5 +1,5 @@
 module OmniFocus::Redmine
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
   def load_or_create_redmine_config
     path   = File.expand_path "~/.omnifocus-redmine.yml"
@@ -7,8 +7,10 @@ module OmniFocus::Redmine
 
     unless config then
       config = {
-        :user          => "Admin User",
+        :user_id       => "20",
         :redmine_url   => "http://redmine",
+        :username      => "UserName",
+        :password      => "Password"
       }
 
       File.open(path, "w") { |f|
@@ -24,22 +26,36 @@ module OmniFocus::Redmine
   def populate_redmine_tasks
     config      = load_or_create_redmine_config
     redmine_url = config[:redmine_url]
-    user_id    = config[:user_id]
+    user_id     = config[:user_id]
+    username    = config[:username]
+    password    = config[:password]
+
+    # Authenticate if the user name and password are defined
+    if username and password then
+      mechanize.basic_auth(username, password)
+    end
+
     default_query = "#{redmine_url}/issues.xml?assigned_to_id=#{user_id}"
 
     unless config[:queries]
-      process_query_results default_query
+      process_query_results(default_query, redmine_url)
     else
       queries = config[:queries]
       queries.each do |q|
-        process_query_results "#{default_query}&#{q}"
+        process_query_results("#{default_query}&#{q}", redmine_url)
       end
     end
   end
 
-  def process_query_results(query)
-    puts query
-    mechanize.get(query)
+  def process_query_results(query, redmine_url)
+    begin
+      mechanize.get(query)
+    rescue Mechanize::ResponseCodeError => e
+      if e.response_code == "401" then
+        abort "Unauthorized.  Check username and password in .omnifocus-redmine"
+      end
+    end
+
     details = Nokogiri.parse(mechanize.current_page.body)
 
     issues = details.root.xpath('//issue')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: omnifocus-redmine
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - aja
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-08 00:00:00 -08:00
+date: 2011-02-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,19 +64,37 @@ dependencies:
         version: 2.8.0
   type: :development
   version_requirements: *id003
-description: "Plugin for the omnifocus gem to provide synchronization with Redmine Issues.\n\n\
-  The first time this runs it creates a yaml file in your home directory for \n\
-  the redmine url and username.\n\n\
-  The queries config is optional.  If it is not included omnifocus-redmine will\n\
-  pull all open bugs assigned to the specified user.\n\n\
-  To use a custom query or multiple queries you must include a queries parameter\n\
-  in your config.\n\n\
-  The queries config is an array of strings.  These strings will be appended onto a\n\
-  query of the form: http://your-redmine-url/issues.xml?assigned_to_id=user-id?.\n\n\
-  Example:\n\
-  :user_id: 20\n\
-  :redmine_url: http://redmine/\n\
-  :queries: [\"status_id=1\", \"status_id=2\"]"
+description: |-
+  Plugin for the omnifocus gem to provide synchronization with Redmine Issues.
+  
+  This plugin uses the Redmine REST API. It must be enabled by an administrator
+  for the plugin to work.  
+  
+  The first time this runs it creates a yaml file in your home directory for 
+  the configuration data.
+  
+   * redmine_url is required. This is the base url for the redmine repository.
+  
+   * user_id is required. To find your user id login and go to the my account
+     page. Your user_id is the number at the end of the url for my account.
+  
+   * username is optional. It is used if the redmine server requires 
+     authentication.  
+  
+   * password is optional. It is used if the redmine server requires 
+     authentication.  
+  
+   * queries is optional. It is used for custom queries or multiple queries. 
+     The queries config is an array of strings.  The strings will be appended 
+     to a query of the form: 
+        "http://redmine_url/issues.xml?assigned_to_id=user_id".
+  
+  Example:
+  :user_id: 20
+  :redmine_url: http://redmine/
+  :username: me
+  :password: 1234
+  :queries: ["status_id=1", "status_id=2"]
 email: 
 - kushali@rubyforge.org
 executables: []