omnifocus-github 1.5.0 → 1.6.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 1.6.0 / 2013-07-24
+
+* 2 major enhancements:
+
+  * Removed support for token authentication 
+  * Use Octokit to access github.
+
+* 1 minor enhancement:
+
+  * Updated dependency to omnifocus 2.x
+
 === 1.5.0 / 2013-05-10
 
 * 1 major enhancement:

data/README.txt

@@ -14,14 +14,14 @@ separated list of github accounts.
 
     git config --global omnifocus-github.accounts "github myghe"
 
-For each account API end point and authentication information are
+For each account API and web end points and authentication information 
 should be stored in the git config under a key matching the
 account. For example:
 
     git config --global github.user me
     git config --global github.password mypassword
     git config --global myghe.api https://ghe.mydomain.com/api/v3
-    git config --global myghe.token 1a2b3c4d5e6f7e8d
+    git config --global myghe.api https://ghe.mydomain.com/
 
 For each account can you specify the following parameters:
 
@@ -29,12 +29,10 @@ For each account can you specify the following parameters:
   https://api.github.com. This is so you can point this at your Github
   Enterprise endpoint.
 
-* user, password - A username and password pair for Basic http authentication.
-
-* token - An OAuth bearer token for OAuth workflows.
+* web - specify an API endpoint other than https://www.github.com. This
+  is so you can point this at your Github Enterprise endpoint
 
-If both a token and a username and password are supplied, the token
-is used.
+* user, password - A username and password pair for Basic http authentication.
 
 == FEATURES/PROBLEMS:
 
@@ -43,6 +41,7 @@ is used.
 == REQUIREMENTS:
 
 * omnifocus
+* octokit
 * ~/.gitrc must have github username defined
 
 == INSTALL:

data/Rakefile

@@ -8,8 +8,9 @@ Hoe.plugin :seattlerb
 Hoe.spec 'omnifocus-github' do
   developer 'Ryan Davis', 'ryand-ruby@zenspider.com'
 
-  dependency "omnifocus", "~> 1.4"
-  dependency "json",      "~> 1.5"
+  dependency "omnifocus", "~> 2.0"
+  dependency "octokit",   "~> 1.24"
+  dependency "system-timer", "~> 1.2" # bug in octokit's deps
 
   self.rubyforge_name = 'seattlerb'
 end

data/lib/omnifocus/github.rb

@@ -1,36 +1,28 @@
-require 'open-uri'
-require 'json'
+require 'octokit'
 
 module OmniFocus::Github
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
   PREFIX  = "GH"
 
-  GH_API_DEFAULT = "https://api.github.com"
-
   def populate_github_tasks
     omnifocus_git_param(:accounts, "github").split(/\s+/).each do |account|
-      api = omnifocus_git_param(:api, GH_API_DEFAULT, account)
+      endpoints = {}
+      endpoints[:api] = omnifocus_git_param(:api, nil, account)
+      endpoints[:web] = omnifocus_git_param(:web, nil, account)
+
       # User + password is required
       auth = {
         :user => omnifocus_git_param(:user, nil, account),
         :password => omnifocus_git_param(:password, nil, account),
-        :token => omnifocus_git_param(:token, nil, account),
       }
       unless (auth[:user] && auth[:password])
         warn "Missing authentication parameters for account #{account}."
         next
       end
 
-      # process will omit the account label if nil.
-      # Supply nil for the default "github" account for compatibility
-      # with previous versions.
       account_label = account == "github" ? nil : account
 
-      body = fetch(api, auth, 1)
-      process(account_label, body)
-      (2..get_last(body)).each do |page|
-        process(account_label, fetch(api, auth, page))
-      end
+      process(account_label, gh_client(account, auth, endpoints))
     end
   end
 
@@ -39,29 +31,31 @@ module OmniFocus::Github
     param.empty? ? default : param
   end
 
-  def fetch api, auth, page
-    uri = URI.parse "#{api}/issues?page=#{page}"
-
-    headers = {
-      "User-Agent"=>"omnifocus-github/#{VERSION}"
-    }
+  def gh_client account, auth, endpoints
+    if account != "github"
+      if endpoints[:api] && endpoints[:web]
+        Octokit.configure do |c|
+          c.api_endpoint = endpoints[:api]
+          c.web_endpoint = endpoints[:web]
+        end
+      else
+        raise ArgumentError, "api and web endpoint configs required for github enterprise"
+      end
+    end
 
     if auth[:user] && auth[:password]
-      headers[:http_basic_authentication] = [auth[:user], auth[:password]]
+      client = Octokit::Client.new(:login => auth[:user],
+                                   :password => auth[:password])
+
+      client.user(auth[:user])
     else
       raise ArgumentError, "Missing authentication"
     end
-
-    uri.read headers
-  end
-
-  def get_last body
-    link, last = body.meta["link"], nil
-    link and link[/page=(\d+).. rel=.last/, 1].to_i or 0
+    client
   end
 
-  def process account, body
-    JSON.parse(body).each do |issue|
+  def process account, client
+    client.user_issues.each do |issue|
       pr        = issue["pull_request"] && !issue["pull_request"]["diff_url"].nil?
       number    = issue["number"]
       url       = issue["html_url"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: omnifocus-github
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 15
   prerelease: 
   segments: 
   - 1
-  - 5
+  - 6
   - 0
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -36,7 +36,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2013-05-10 00:00:00 Z
+date: 2013-07-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: omnifocus
@@ -46,32 +46,47 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
-        - 1
-        - 4
-        version: "1.4"
+        - 2
+        - 0
+        version: "2.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: octokit
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 63
         segments: 
         - 1
-        - 5
-        version: "1.5"
+        - 24
+        version: "1.24"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: system-timer
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -82,11 +97,11 @@ dependencies:
         - 0
         version: "5.0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,22 +112,22 @@ dependencies:
         - 0
         version: "4.0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 9
         segments: 
         - 3
-        - 6
-        version: "3.6"
+        - 7
+        version: "3.7"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: |-
   Plugin for omnifocus gem to provide github BTS synchronization.
   
@@ -123,14 +138,14 @@ description: |-
   
       git config --global omnifocus-github.accounts "github myghe"
   
-  For each account API end point and authentication information are
+  For each account API and web end points and authentication information 
   should be stored in the git config under a key matching the
   account. For example:
   
       git config --global github.user me
       git config --global github.password mypassword
       git config --global myghe.api https://ghe.mydomain.com/api/v3
-      git config --global myghe.token 1a2b3c4d5e6f7e8d
+      git config --global myghe.api https://ghe.mydomain.com/
   
   For each account can you specify the following parameters:
   
@@ -138,12 +153,10 @@ description: |-
     https://api.github.com. This is so you can point this at your Github
     Enterprise endpoint.
   
-  * user, password - A username and password pair for Basic http authentication.
+  * web - specify an API endpoint other than https://www.github.com. This
+    is so you can point this at your Github Enterprise endpoint
   
-  * token - An OAuth bearer token for OAuth workflows.
-  
-  If both a token and a username and password are supplied, the token
-  is used.
+  * user, password - A username and password pair for Basic http authentication.
 email: 
 - ryand-ruby@zenspider.com
 executables: []
@@ -162,8 +175,8 @@ files:
 - Rakefile
 - lib/omnifocus/github.rb
 homepage: https://github.com/seattlerb/omnifocus-github
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: 
 - --main