@@ -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 README.rdoc 3eb9f9c111abbe65dd2d18ffc0530f310f7873ea Ryan Bigg radarlistener@gmail.com http://github.com/fcoury/octopi/commit/8dcbf5755d7769b5ac408c3569cac3f1147a38ed 8dcbf5755d7769b5ac408c3569cac3f1147a38ed 2009-08-06T00:02:43-07:00 2009-08-06T00:02:43-07:00 Updated readme. 64b21c0627b24f6201ff8b9d678cdc1e16839e04 Ryan Bigg radarlistener@gmail.com