octopi 0.1.0 → 0.2.1

data/.gitignore

@@ -1,3 +1,4 @@
 examples/github.yml
-rdoc/
+doc/
 pkg/
+contrib/nothingspecial.rb

data/README.rdoc

@@ -15,9 +15,8 @@ http://twitter.com/octopi_gem
 
 If you have your <tt>~/.gitconfig</tt> file in place, and you have a [github] section (if you don't, take a look at this GitHub Guides entry: http://github.com/guides/tell-git-your-user-name-and-email-address), you can use seamless authentication using this method:
 
-  authenticated do |g|
-    repo = g.repository("api-labrat")
-    (...)
+  authenticated do 
+    repo = Repository.find(:name => "api-labrat", :user => "fcoury")
   end
   
 === Explicit authentication
@@ -26,14 +25,23 @@ Sometimes, you may not want to get authentication data from <tt>~/.gitconfig</tt
 
 <b>1. Providing login and token inline:</b>
 
-  authenticated_with "mylogin", "mytoken" do |g|
-    repo = g.repository("api-labrat")
+  authenticated_with "mylogin", "mytoken" do 
+    repo = Repository.find(:name => "api-labrat", :user => "fcoury")
     issue = repo.open_issue :title => "Sample issue", 
       :body => "This issue was opened using GitHub API and Octopi"
     puts issue.number
   end
-  
-<b>2. Providing a YAML file with authentication information:</b>
+
+<b>2. Providing login and password inline:</b>
+
+  authenticated_with "mylogin", "password" do 
+    repo = Repository.find(:name => "api-labrat", :user => "fcoury")
+    issue = repo.open_issue :title => "Sample issue", 
+      :body => "This issue was opened using GitHub API and Octopi"
+    puts issue.number
+  end
+
+<b>3. Providing a YAML file with authentication information:</b>
 
 Use the following format:
 
@@ -116,40 +124,6 @@ Single commit information:
   puts "Diff:"
   first_commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
 
-== Tracing
-
-=== Levels
-
-You can can use tracing to enable better debugging output when something goes wrong. There are 3 tracing levels: 
-
-* false (default) - no tracing
-* true - will output each GET and POST calls, along with URL and params
-* curl - same as true, but additionally outputs the curl command to replicate the issue
-
-If you choose curl tracing, the curl command equivalent to each command sent to GitHub will be output to the stdout, like this example:
-
-  => Trace on: curl
-  POST: /issues/open/webbynode/api-labrat params: body=This issue was opened using GitHub API and Octopi, title=Sample issue
-  ===== curl version
-  curl -F 'body=This issue was opened using GitHub API and Octopi' -F 'login=mylogin' -F 'token=mytoken' -F 'title=Sample issue' http://github.com/api/v2/issues/open/webbynode/api-labrat
-  ==================
-  
-=== Enabling
-
-Tracing can be enabled in different ways, depending on the API feature you're using:
-
-<b>Anonymous (this will be improved later):</b>
-
-  ANONYMOUS_API.trace_level = "trace-level"
-  
-<b>Seamless authenticated</b>
-
-  authenticated :trace => "trace-level" do |g|; ...; end
-  
-<b>Explicitly authenticated</b>
-
-Current version of explicit authentication requires a :config param to a YAML file to allow tracing. For enabling tracing on a YAML file refer to the config.yml example presented on the Explicit authentication section.
-
 == Author
 
 * Felipe Coury - http://felipecoury.com
@@ -159,6 +133,7 @@ Current version of explicit authentication requires a :config param to a YAML fi
 
 In alphabetical order:
 
+* Ryan Bigg - http://frozenplague.net
 * Brandon Calloway - http://github.com/bcalloway
 * runpaint - http://github.com/runpaint
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'yaml'
 
 begin
   require 'jeweler'
@@ -10,9 +11,17 @@ begin
     gem.homepage = "http://github.com/fcoury/octopi"
     gem.authors = ["Felipe Coury"]
     gem.rubyforge_project = "octopi"
+    gem.add_dependency('nokogiri', '>= 1.3.1')
+    gem.add_dependency('httparty', '>= 0.4.5')
+    gem.files.exclude 'test/**/*'
+    gem.files.exclude 'test*'
+    gem.files.exclude 'doc/**/*'
+    gem.files.exclude 'examples/**/*'
+    
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 1
-:patch: 0
+:minor: 2
+:patch: 1

data/examples/overall.rb

@@ -36,7 +36,7 @@ puts "Commit: #{commit.id} - #{commit.message} - by #{commit.author['name']}"
 # single commit information
 # details is the same as: Commit.find(commit)
 puts "Diff:"
-commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
+commit.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
 
 # repository search
 repos = Repository.find_all("ruby", "git")

data/lib/ext/hash_ext.rb

@@ -0,0 +1,5 @@
+class Hash
+  def method_missing(method, *args)
+    self[method] || self[method.to_s]
+  end
+end

data/lib/ext/string_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def camel_case
+    self.gsub(/(^|_)(.)/) { $2.upcase }
+  end
+end

data/lib/octopi.rb

@@ -1,236 +1,135 @@
 require 'rubygems'
+
 require 'httparty'
+require 'mechanize'
+require 'nokogiri'
+require 'api_cache'
+
 require 'yaml'
 require 'pp'
 
-module Octopi
-  def authenticated(*args, &block)
-    opts = args.last.is_a?(Hash) ? args.last : {}
-    config = read_gitconfig
-    login = config["github"]["user"]
-    token = config["github"]["token"]
-    
-    api = AuthApi.new(login, token)
-    api.trace_level = opts[:trace]
-    
-    puts "=> Trace on: #{api.trace_level}" if api.trace_level
+# Core extension stuff
+Dir[File.join(File.dirname(__FILE__), "ext/*.rb")].each { |f| require f }
 
-    yield api
-  end
+# Octopi stuff
+Dir[File.join(File.dirname(__FILE__), "octopi/*.rb")].each { |f| require f }
+
+# Include this into your app so you can access the child classes easier.
+# This is the root of all things Octopi.
+module Octopi
   
-  def authenticated_with(*args, &block)
-    opts = args.last.is_a?(Hash) ? args.last : {}
-    if opts[:config]
-      config = File.open(opts[:config]) { |yf| YAML::load(yf) }
-      raise "Missing config #{opts[:config]}" unless config
-      
-      login = config["login"]
-      token = config["token"]
-      trace = config["trace"]
-    else
-      login, token = *args
-    end
-    
-    puts "=> Trace on: #{trace}" if trace
-    
-    api = AuthApi.new(login, token)
-    api.trace_level = trace if trace
-    yield api
-  end
+  # The authenticated methods are all very similar.
+  # TODO: Find a way to merge them into something... better.
   
-  def read_gitconfig
-    config = {}
-    group = nil
-    File.foreach("#{ENV['HOME']}/.gitconfig") do |line|
-      line.strip!
-      if line[0] != ?# and line =~ /\S/
-        if line =~ /^\[(.*)\]$/
-          group = $1
-        else
-          key, value = line.split("=")
-          value ||= ''
-          (config[group]||={})[key.strip] = value.strip
-        end
+  def authenticated(options={}, &block)
+    begin
+      config = config = File.open(options[:config]) { |yf| YAML::load(yf) } if options[:config]
+      config = read_gitconfig
+      options[:login] = config["github"]["user"]
+      options[:token] = config["github"]["token"]
+      
+      authenticated_with(options) do
+        yield 
       end
+    ensure
+      # Reset authenticated so if we were to do an anonymous call it would Just Work(tm)
+      Api.authenticated = false
+      Api.api = AnonymousApi.instance
     end
-    config
   end
   
-  class Api
-    CONTENT_TYPE = {
-      'yaml' => 'application/x-yaml',
-      'json' => 'application/json',
-      'xml'  => 'application/sml'
-    }  
-    RETRYABLE_STATUS = [403]
-    MAX_RETRIES = 10
-      
-    attr_accessor :format, :login, :token, :trace_level, :read_only
-  
-    def initialize(login = nil, token = nil, format = "yaml")
-      @format = format
-      @read_only = true
+  def authenticated_with(options, &block)
+    begin
+
+      Api.api.trace_level = options[:trace] if options[:trace]
       
-      if login
-        @login = login
-        @token = token
-        @read_only = false
-        self.class.default_params :login => login, :token => token
+      if options[:token].nil? && !options[:password].nil?
+        options[:token] = grab_token(options[:login], options[:password])
       end
-    end
-
-    def read_only?
-      read_only
-    end
-
-    {:keys => 'public_keys', :emails => 'emails'}.each_pair do |action, key|
-      define_method("#{action}") do
-        get("/user/#{action}")[key]
+      begin
+        User.find(options[:login])
+        # If the user cannot see themselves then they are not logged in, tell them so
+      rescue Octopi::NotFound
+        raise Octopi::InvalidLogin
       end
-    end
-
-    def user
-      user_data = get("/user/show/#{login}")
-      raise "Unexpected response for user command" unless user_data and user_data['user']
-      User.new(self, user_data['user'])
-    end
     
-    def open_issue(user, repo, params)
-      Issue.open(user, repo, params, self)
-    end
+      trace("=> Trace on: #{options[:trace]}")
     
-    def repository(name)
-      repo = Repository.find(user, name, self)
-      repo.api = self
-      repo
-    end
-    alias_method :repo, :repository
+      Api.api = AuthApi.instance
+      Api.api.login = options[:login]
+      Api.api.token = options[:token]
     
-    def commits(repo,opts={})
-      branch = opts[:branch] || "master"
-      commits = Commit.find_all(repo, branch, self)
+      yield
+    ensure
+      # Reset authenticated so if we were to do an anonymous call it would Just Work(tm)
+      Api.authenticated = false
+      Api.api = AnonymousApi.instance
     end
+  end
     
-    def save(resource_path, data)
-      traslate resource_path, data
-      #still can't figure out on what format values are expected
-      post("#{resource_path}", { :query => data })
-    end
+  private
+  
+  def grab_token(username, password)
+    a = WWW::Mechanize.new { |agent|
+      # Fake out the agent
+      agent.user_agent_alias = 'Mac Safari'
+    }
     
-    def find(path, result_key, resource_id)
-      get(path, { :id => resource_id }) 
-    end
+    # Login with the provided 
+    a.get('http://github.com/login') do |page|
+      user_page = page.form_with(:action => '/session') do |login|
+        login.login = username
+        login.password = password
+      end.submit
 
-    def find_all(path, result_key, query)
-      get(path, { :query => query, :id => query })[result_key]
-    end
-    
-    def get_raw(path, params)
-     get(path, params, 'plain')
-    end
-    
-    def get(path, params = {}, format = "yaml")
-      @@retries = 0
-      begin
-        trace "GET [#{format}]", "/#{format}#{path}", params
-        submit(path, params, format) do |path, params, format|
-          self.class.get "/#{format}#{path}"
-        end
-      rescue RetryableAPIError => e
-        if @@retries < MAX_RETRIES 
-          $stderr.puts e.message
-          @@retries += 1
-          sleep 6
-          retry
-        else  
-          raise APIError, "GitHub returned status #{e.code}, despite" +
-           " repeating the request #{MAX_RETRIES} times. Giving up."
-        end  
-      end  
-    end
-    
-    def post(path, params = {}, format = "yaml")
-      @@retries = 0
-      begin
-        trace "POST", "/#{format}#{path}", params
-        submit(path, params, format) do |path, params, format|
-          resp = self.class.post "/#{format}#{path}", :body => params
-          resp
-        end
-      rescue RetryableAPIError => e
-        if @@retries < MAX_RETRIES
-          $stderr.puts e.message
-          @@retries += 1
-          sleep 6
-          retry
-        else
-          raise APIError, "GitHub returned status #{e.code}, despite" +
-           " repeating the request #{MAX_RETRIES} times. Giving up."
-        end
-      end
-    end
 
-    private
-    def submit(path, params = {}, format = "yaml", &block)
-      params.each_pair do |k,v|
-        if path =~ /:#{k.to_s}/
-          params.delete(k)
-          path = path.gsub(":#{k.to_s}", v)
-        end
+      if Api.api.trace_level
+        File.open("got.html", "w+") do |f|
+          f.write user_page.body
+        end   
+        `open got.html`
       end
-      query = login ? { :login => login, :token => token } : {}
-      query.merge!(params)
       
-      begin
-        resp = yield(path, query.merge(params), format)
-      rescue Net::HTTPBadResponse
-        raise RetryableAPIError
-      end
+      body = Nokogiri::HTML(user_page.body)
+      error = body.xpath("//div[@class='error_box']").text
+      raise error if error != ""
       
-      if @trace_level
-        case @trace_level
-          when "curl"
-            query_trace = []
-            query.each_pair { |k,v| query_trace << "-F '#{k}=#{v}'" }
-            puts "===== [curl version]"
-            puts "curl #{query_trace.join(" ")} #{self.class.base_uri}/#{format}#{path}"
-            puts "===================="
+      # Should be clear to go if there is no errors.
+      link = user_page.link_with(:text => "account")
+      @account_page = a.click(link)
+      if Api.api.trace_level
+        File.open("account.html", "w+") do |f|
+          f.write @account_page.body
         end
+        `open account.html`
       end
-      raise RetryableAPIError, resp.code.to_i if RETRYABLE_STATUS.include? resp.code.to_i
-      raise APIError, 
-        "GitHub returned status #{resp.code}" unless resp.code.to_i == 200
-      # FIXME: This fails for showing raw Git data because that call returns
-      # text/html as the content type. This issue has been reported.
-      ctype = resp.headers['content-type'].first
-      raise FormatError, [ctype, format] unless 
-        ctype.match(/^#{CONTENT_TYPE[format]};/)
-      if format == 'yaml' && resp['error']
-        raise APIError, resp['error'].first['error']
-      end  
-      resp
-    end
-    
-    def trace(oper, url, params)
-      return unless trace_level
-      par_str = " params: " + params.map { |p| "#{p[0]}=#{p[1]}" }.join(", ") if params and !params.empty?
-      puts "#{oper}: #{url}#{par_str}"
+      
+      return Nokogiri::HTML(@account_page.body).xpath("//p").xpath("strong")[1].text
     end
   end
   
-  class AuthApi < Api
-    include HTTParty
-    base_uri "https://github.com/api/v2"
-  end
-    
-  class AnonymousApi < Api
-    include HTTParty
-    base_uri "http://github.com/api/v2"
+  
+  def read_gitconfig
+    config = {}
+    group = nil
+    File.foreach("#{ENV['HOME']}/.gitconfig") do |line|
+      line.strip!
+      if line[0] != ?# && line =~ /\S/
+        if line =~ /^\[(.*)\]$/
+          group = $1
+          config[group] ||= {}
+        else
+          key, value = line.split("=").map { |v| v.strip }
+          config[group][key] = value
+        end
+      end
+    end
+    config
   end
   
-  ANONYMOUS_API = AnonymousApi.new
-    
-  %w{error base resource user tag repository issue file_object blob key commit branch}.
-    each{|f| require "#{File.dirname(__FILE__)}/octopi/#{f}"} 
-
+  def trace(text)
+    if Api.api.trace_level
+      puts "text"
+    end
+  end
 end