github_api 0.6.1 → 0.6.2

data/lib/github_api.rb

@@ -75,6 +75,7 @@ module Github
     :Users           => 'users',
     :Events          => 'events',
     :Search          => 'search',
+    :Markdown        => 'markdown',
     :CoreExt         => 'core_ext',
     :MimeType        => 'mime_type',
     :Authorization   => 'authorization',

data/lib/github_api/api.rb

@@ -24,6 +24,7 @@ module Github
     include Normalizer
 
     attr_reader *Configuration::VALID_OPTIONS_KEYS
+
     attr_accessor *VALID_API_KEYS
 
     # Callback to update global configuration options
@@ -37,8 +38,10 @@ module Github
     end
 
     # Creates new API
-    def initialize(options = {}, &block)
+    def initialize(options={}, &block)
+      super()
       options = Github.options.merge(options)
+
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
@@ -93,6 +96,7 @@ module Github
       { 'user' => self.user, 'repo' => self.repo }.merge!(params)
     end
 
+    # TODO: See whether still needed, consider adding to core_exts
     def _hash_traverse(hash, &block)
       hash.each do |key, val|
         block.call(key)

data/lib/github_api/client.rb

@@ -3,6 +3,12 @@
 module Github
   class Client < API
 
+    # This is a read-only API to the GitHub events.
+    # These events power the various activity streams on the site.
+    def events(options = {})
+      @events ||= ApiFactory.new 'Events', options
+    end
+
     def gists(options = {})
       @gists ||= ApiFactory.new 'Gists', options
     end
@@ -19,6 +25,17 @@ module Github
       @issues ||= ApiFactory.new 'Issues', options
     end
 
+    def markdown(options = {})
+      @markdown ||= ApiFactory.new 'Markdown', options
+    end
+
+    # An API for users to manage their own tokens. You can only access your own
+    # tokens, and only through Basic Authentication.
+    def oauth(options = {})
+      @oauth ||= ApiFactory.new 'Authorizations', options
+    end
+    alias :authorizations :oauth
+
     def orgs(options = {})
       @orgs ||= ApiFactory.new 'Orgs', options
     end
@@ -33,28 +50,15 @@ module Github
     end
     alias :repositories :repos
 
-    # Many of the resources on the users API provide a shortcut for getting 
-    # information about the currently authenticated user.
-    def users(options = {})
-      @users ||= ApiFactory.new 'Users', options
-    end
-
-    # This is a read-only API to the GitHub events.
-    # These events power the various activity streams on the site.
-    def events(options = {})
-      @events ||= ApiFactory.new 'Events', options
-    end
-
     def search(options = {})
       @search ||= ApiFactory.new 'Search', options
     end
 
-    # An API for users to manage their own tokens. You can only access your own
-    # tokens, and only through Basic Authentication.
-    def oauth(options = {})
-      @oauth ||= ApiFactory.new 'Authorizations', options
+    # Many of the resources on the users API provide a shortcut for getting 
+    # information about the currently authenticated user.
+    def users(options = {})
+      @users ||= ApiFactory.new 'Users', options
     end
-    alias :authorizations :oauth
 
   end # Client
 end # Github

data/lib/github_api/connection.rb

@@ -12,29 +12,34 @@ require 'github_api/request/jsonize'
 
 module Github
   module Connection
+    extend self
+    include Github::Constants
 
-  ALLOWED_OPTIONS = [
-    :headers,
-    :url,
-    :params,
-    :request,
-    :ssl
-  ].freeze
-
-  private
+    ALLOWED_OPTIONS = [
+      :headers,
+      :url,
+      :params,
+      :request,
+      :ssl
+    ].freeze
 
     def default_options(options={}) # :nodoc:
       {
         :headers => {
-          :accept       => '*/*', #accepts,
-          :user_agent   => user_agent,
-          :content_type => 'application/x-www-form-urlencoded'
+          ACCEPT           => "application/vnd.github.v3.raw+json," \
+                              "application/vnd.github.beta.raw+json;q=0.5," \
+                              "application/json;q=0.1",
+          ACCEPT_CHARSET   => "utf-8",
+          USER_AGENT       => user_agent,
+          CONTENT_TYPE     => 'application/x-www-form-urlencoded'
         },
         :ssl => { :verify => false },
-        :url => endpoint
-      }
+        :url => options.fetch(:endpoint) { Github.endpoint }
+      }.merge(options)
     end
 
+    @connection = nil
+
     def clear_cache # :nodoc:
       @connection = nil
     end
@@ -45,12 +50,12 @@ module Github
 
     def connection(options = {}) # :nodoc:
 
-      merged_options = filter! ALLOWED_OPTIONS, default_options.merge(options)
+      conn_options = default_options(options)
       clear_cache unless options.empty?
 
       @connection ||= begin
-        Faraday.new(merged_options.merge(connection_options)) do |builder|
-          puts options.inspect if ENV['DEBUG']
+        Faraday.new(conn_options) do |builder|
+          puts "OPTIONS:#{conn_options.inspect}" if ENV['DEBUG']
 
           builder.use Github::Request::Jsonize
           builder.use Faraday::Request::Multipart

data/lib/github_api/constants.rb

@@ -21,6 +21,12 @@ module Github
 
     LOCATION = 'Location'.freeze
 
+    USER_AGENT = 'User-Agent'.freeze
+
+    ACCEPT = 'Accept'.freeze
+
+    ACCEPT_CHARSET = 'Accept-Charset'.freeze
+
     # Link headers
     HEADER_LINK = "Link".freeze
 

data/lib/github_api/markdown.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module Github
+  class Markdown < API
+
+    # Creates new Markdown API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # Render an arbritrary Markdown document
+    #
+    # = Parameters
+    #  <tt>:text</tt> - Required string - The Markdown text to render
+    #  <tt>:mode<tt> - Optional string - The rendering mode
+    #    * <tt>markdown</tt> to render a document as plain Markdown, just
+    #                        like README files are rendered.
+    #    * <tt>gfm</tt> to render a document as user-content, e.g. like user
+    #      comments or issues are rendered. In GFM mode, hard line breaks are
+    #      always taken into account, and issue and user mentions are
+    #      linked accordingly.
+    #  <tt>:context<tt> - Optional string - The repository context, only taken
+    #                     into account when rendering as <tt>gfm</tt>
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.markdown.render
+    #    "text": "Hello world github/linguist#1 **cool**, and #1!",
+    #    "mode": "gfm",
+    #    "context": "github/gollum"
+    #
+    def render(*args)
+      params = args.extract_options!
+      normalize! params
+
+      assert_required_keys ['text'], params
+      post_request("markdown", params, :raw => true)
+    end
+
+
+    # Render a Markdown document in raw mode
+    #
+    # = Input
+    #  The raw API it not JSON-based. It takes a Markdown document as plaintext
+    #  <tt>text/plain</tt> or <tt>text/x-markdown</tt> and renders it as plain
+    #  Markdown without a repository context (just like a README.md file is
+    #  rendered – this is the simplest way to preview a readme online)
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.markdown.render_raw "Hello github/linguist#1 **cool**, and #1!",
+    #    "mime": "text/plain",
+    #
+    def render_raw(*args)
+      params = args.extract_options!
+      normalize! params
+      mime_type, params['data'] = params['mime'], args.shift
+
+      post_request("markdown/raw", params, :raw => true,
+                      :headers => {'Content-Type' => mime_type || 'text/plain'})
+    end
+
+  end # Markdown
+end # Github

data/lib/github_api/repos.rb

@@ -108,6 +108,19 @@ module Github
     end
     alias :list_branches :branches
 
+    # Get branch
+    #
+    # = Examples
+    #
+    #   github = Github.new
+    #   github.repos.branch 'user-name', 'repo-name', 'branch-name'
+    #
+    def branch(user_name, repo_name, branch, params={})
+      normalize! params
+
+      get_request("repos/#{user_name}/#{repo_name}/branches/#{branch}", params)
+    end
+
     # Create a new repository for the autheticated user.
     #
     # = Parameters

data/lib/github_api/repos/contents.rb

@@ -22,6 +22,9 @@ module Github
     #
     # This method returns the contents of any file or directory in a repository.
     #
+    # = Parameters
+    # * <tt>:ref</tt> - Optional string - valid Git reference, defaults to master
+    #
     # = Examples
     #  github = Github.new
     #  github.repos.contents.get 'user-name', 'repo-name', 'path'

data/lib/github_api/request.rb

@@ -31,18 +31,21 @@ module Github
       if !METHODS.include?(method)
         raise ArgumentError, "unkown http method: #{method}"
       end
-      _extract_mime_type(params, options)
+      # _extract_mime_type(params, options)
 
       puts "EXECUTED: #{method} - #{path} with #{params} and #{options}" if ENV['DEBUG']
 
-      response = connection(options).send(method) do |request|
+      conn = connection(options)
+      path = (conn.path_prefix + path).gsub(/\/\//,'/') if conn.path_prefix != '/'
+
+      response = conn.send(method) do |request|
         case method.to_sym
         when *(METHODS - METHODS_WITH_BODIES)
           request.body = params.delete('data') if params.has_key?('data')
           request.url(path, params)
         when *METHODS_WITH_BODIES
           request.path = path
-          request.body = _process_params(params) unless params.empty?
+          request.body = extract_data_from_params(params) unless params.empty?
         end
       end
       response.body
@@ -50,7 +53,7 @@ module Github
 
     private
 
-    def _process_params(params) # :nodoc:
+    def extract_data_from_params(params) # :nodoc:
       return params['data'] if params.has_key?('data') and !params['data'].nil?
       return params
     end

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 6
-    PATCH = 1
+    PATCH = 2
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/fixtures/repos/branch.json

@@ -0,0 +1,53 @@
+{
+  "name": "master",
+  "commit": {
+    "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+    "commit": {
+      "author": {
+        "name": "The Octocat",
+        "date": "2012-03-06T15:06:50-08:00",
+        "email": "octocat@nowhere.com"
+      },
+      "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+      "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+      "tree": {
+        "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
+        "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
+      },
+      "committer": {
+        "name": "The Octocat",
+        "date": "2012-03-06T15:06:50-08:00",
+        "email": "octocat@nowhere.com"
+      }
+    },
+    "author": {
+      "gravatar_id": "7ad39074b0584bc555d0417ae3e7d974",
+      "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "url": "https://api.github.com/users/octocat",
+      "id": 583231,
+      "login": "octocat"
+    },
+    "parents": [
+      {
+        "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+        "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
+      },
+      {
+        "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
+        "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303"
+      }
+    ],
+    "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+    "committer": {
+      "gravatar_id": "7ad39074b0584bc555d0417ae3e7d974",
+      "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "url": "https://api.github.com/users/octocat",
+      "id": 583231,
+      "login": "octocat"
+    }
+  },
+  "_links": {
+    "html": "https://github.com/octocat/Hello-World/tree/master",
+    "self": "https://api.github.com/repos/octocat/Hello-World/branches/master"
+  }
+}

data/spec/github/gists/comments_spec.rb

@@ -121,7 +121,7 @@ describe Github::Gists::Comments do
     context "resouce created" do
       before do
         stub_post("/gists/#{gist_id}/comments").
-          with(:body => JSON.generate(inputs.except('unrelated'))).
+          with(inputs.except('unrelated')).
           to_return(:body => fixture('gists/comment.json'),
                 :status => 201,
                 :headers => {:content_type => "application/json; charset=utf-8"})
@@ -173,7 +173,7 @@ describe Github::Gists::Comments do
     context "resouce edited" do
       before do
         stub_patch("/gists/comments/#{comment_id}").
-          with(:body => JSON.generate(inputs.except('unrelated'))).
+          with(inputs.except('unrelated')).
           to_return(:body => fixture('gists/comment.json'),
                 :status => 201,
                 :headers => {:content_type => "application/json; charset=utf-8"})

data/spec/github/gists_spec.rb

@@ -200,10 +200,10 @@ describe Github::Gists do
     context "resouce created" do
       before do
         stub_post("/gists").
-          with(:body => JSON.generate(inputs)).
+          with(inputs).
           to_return(:body => fixture('gists/gist.json'),
-                :status => 201,
-                :headers => {:content_type => "application/json; charset=utf-8"})
+            :status => 201,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should fail to create resource if 'files' input is missing" do
@@ -280,10 +280,10 @@ describe Github::Gists do
     context "resouce edited" do
       before do
         stub_patch("/gists/#{gist_id}").
-          with(:body => JSON.generate(inputs)).
+          with(inputs).
           to_return(:body => fixture('gists/gist.json'),
-                :status => 200,
-                :headers => {:content_type => "application/json; charset=utf-8"})
+            :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should edit resource successfully" do

data/spec/github/git_data/blobs_spec.rb

@@ -73,7 +73,7 @@ describe Github::GitData::Blobs do
     context "resouce created" do
       before do
         stub_post("/repos/#{user}/#{repo}/git/blobs").
-          with(:body => JSON.generate(inputs.except('unrelated'))).
+          with(inputs.except('unrelated')).
           to_return(:body => fixture('git_data/blob_sha.json'),
             :status => 201,
             :headers => {:content_type => "application/json; charset=utf-8"})

data/spec/github/git_data/commits_spec.rb

@@ -79,7 +79,7 @@ describe Github::GitData::Commits, :type => :base do
     context "resouce created" do
       before do
         stub_post("/repos/#{user}/#{repo}/git/commits").
-          with(:body => JSON.generate(inputs.except('unrelated'))).
+          with(inputs.except('unrelated')).
           to_return(:body => fixture('git_data/commit.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
       end
 

data/spec/github/git_data/references_spec.rb

@@ -154,7 +154,7 @@ describe Github::GitData::References do
     context "resouce created" do
       before do
         stub_post("/repos/#{user}/#{repo}/git/refs").
-          with(:body => JSON.generate(inputs.except('unrelated'))).
+          with(inputs.except('unrelated')).
           to_return(:body => fixture('git_data/reference.json'), :status => 201,
             :headers => {:content_type => "application/json; charset=utf-8"})
       end
@@ -220,7 +220,7 @@ describe Github::GitData::References do
     context "resouce updated" do
       before do
         stub_patch("/repos/#{user}/#{repo}/git/refs/#{ref}").
-          with(:body => JSON.generate(inputs.except('unrelated'))).
+          with(inputs.except('unrelated')).
           to_return(:body => fixture('git_data/reference.json'), :status => 201, :headers => {:content_type => "application/json; charset=utf-8"})
       end