github_api 0.1.0.pre

data/lib/github_api/api/extract_options.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+    class Hash
+      def extractable_options?
+        instance_of?(Hash)
+      end
+    end
+
+    class Array
+      def extract_options!
+        if last.is_a?(Hash) && last.extractable_options?
+          pop
+        else
+          {}
+        end
+      end
+    end

data/lib/github_api/api/mime.rb

@@ -0,0 +1,5 @@
+module Github
+  class Mime < API
+    
+  end
+end

data/lib/github_api/api/utils.rb

@@ -0,0 +1,9 @@
+module Github
+  class API
+    module Utils
+      
+      private
+
+    end
+  end
+end

data/lib/github_api/client.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Github
+  class Client < API
+
+    def gists(options = {})
+      @gists ||= Github::Gists.new(options)
+    end
+
+    def git_data(options)
+      @git_data ||= Github::GitData.new(options)
+    end
+
+    def issues(options = {})
+      @issues ||= Github::Issues.new(options)
+    end
+
+    def orgs(options = {})
+      @orgs ||= Github::Orgs.new(options)
+    end
+
+    def pull_requests(options = {})
+      @pull_requests ||= Github::PullRequests.new(options)
+    end
+
+    def repos(options = {})
+      @repos ||= Github::Repos.new(options)
+    end
+
+    def users(options = {})
+      @users ||= Github::Users.new(options)
+    end
+
+  end # Client
+end # Github

data/lib/github_api/configuration.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+module Github
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :client_id,
+      :client_secret,
+      :oauth_token,
+      :endpoint,
+      :format,
+      :resource,
+      :user_agent,
+      :faraday_options,
+      :repo,
+      :user
+    ].freeze
+
+    # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
+    DEFAULT_ADAPTER = :net_http
+
+    # By default, don't set an application key
+    DEFAULT_CLIENT_ID = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CLIENT_SECRET = nil
+
+    # By default, don't set a user oauth access token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # The endpoint used to connect to GitHub if none is set
+    DEFAULT_ENDPOINT = 'https://api.github.com/'.freeze
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    DEFAULT_USER_AGENT = "Github Ruby Gem #{Github::VERSION::STRING}".freeze
+
+    DEFAULT_FORMAT = :json
+
+    # By default,  
+    DEFAULT_RESOURCE = nil
+
+    DEFAULT_FARADAY_OPTIONS = {}
+
+    # By default, don't set user name
+    DEFAULT_USER = nil
+
+    # By default, don't set repository name
+    DEFAULT_REPO = nil
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Convenience method to allow for global setting of configuration options
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_defaults
+    end
+
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
+      options
+    end
+
+    def set_defaults
+      self.adapter            = DEFAULT_ADAPTER
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.faraday_options    = DEFAULT_FARADAY_OPTIONS
+      self.format             = DEFAULT_FORMAT
+      self.resource           = DEFAULT_RESOURCE
+      self.user               = DEFAULT_USER
+      self.repo               = DEFAULT_REPO
+      self
+    end
+
+  end # Configuration
+end # Github

data/lib/github_api/connection.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'github_api/response'
+require 'github_api/response/mashify'
+require 'github_api/response/jsonize'
+require 'github_api/response/raise_error'
+require 'github_api/request/oauth2'
+
+module Github
+  module Connection
+
+    # Available resources 
+    RESOURCES = {
+      :issue         => 'vnd.github-issue.',
+      :issuecomment  => 'vnd.github-issuecomment.',
+      :commitcomment => 'vnd.github-commitcomment',
+      :pull          => 'vnd.github-pull.',
+      :pullcomment   => 'vnd.github-pullcomment.',
+      :gistcomment   => 'vnd.github-gistcomment.'
+    }
+
+    # Mime types used by resources
+    RESOURCE_MIME_TYPES = {
+      :raw  => 'raw+json',
+      :text => 'text+json',
+      :html => 'html+json',
+      :full => 'html+full'
+    }
+
+    BLOB_MIME_TYPES = {
+      :raw => 'vnd.github-blob.raw',
+      :json => 'json'
+    }
+
+    def default_faraday_options()
+      {
+        :headers => {
+          'Accept' => "application/#{resource}#{format}",
+          'User-Agent' => user_agent
+        },
+        :ssl => { :verify => false },
+        :url => endpoint
+      }
+    end
+
+    # TODO Write mime format conversion
+
+    # Create cache hash and store connection there and then pass it to @connection
+    # add method to invalidate it if previous options are different from current
+
+    def clear_cache
+      @connection = nil
+    end
+
+    def caching?
+      !@connection.nil?
+    end
+
+    def connection(options = {})
+      merged_options = faraday_options.merge(default_faraday_options)
+
+      clear_cache unless options.empty?
+
+      @connection ||= begin
+        Faraday.new(merged_options) do |builder|
+
+          puts options.inspect
+
+          builder.use Faraday::Request::JSON
+          builder.use Faraday::Request::Multipart
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Response::Logger
+
+          builder.use Github::Request::OAuth2, oauth_token if oauth_token?
+
+          unless options[:raw]
+            builder.use Github::Response::Mashify
+            builder.use Github::Response::Jsonize
+          end
+
+          builder.use Github::Response::RaiseError
+          builder.adapter adapter
+        end
+      end
+
+    end
+
+  end # Connection
+end # Github
+

data/lib/github_api/error.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Github
+  class Error < StandardError
+    attr_reader :response_message, :response_headers
+
+    def initialize(message, headers)
+      @response_message = message 
+      super message
+    end
+
+    def inspect
+      %(#<#{self.class}>)
+    end
+  end # Error
+
+  # Raised when Github returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Github returns the HTTP status code 401
+  class Unauthorised < Error; end
+
+  # Raised when Github returns the HTTP status code 403
+  class Forbidden < Error; end 
+
+  # Raised when Github returns the HTTP status code 404
+  class ResourceNotFound < Error; end
+
+  # Raised when Github returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Github returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+end # Github

data/lib/github_api/gists.rb

@@ -0,0 +1,199 @@
+# encoding: utf-8
+
+module Github
+  class Gists < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/gists',
+      :Comments => 'comments'
+
+    include Github::Gists::Comments
+
+    REQUIRED_GIST_INPUTS = %w[ description public files content ]
+
+    # Creates new Gists API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List a user's gists.
+    #
+    # = Examples
+    #  @github = Github.new :user => 'user-name'
+    #  @github.gists.gists
+    #
+    # List the authenticated user’s gists or if called anonymously, 
+    # this will returns all public gists
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.gists.gists
+    #
+    def gists(user_name=nil, params={})
+      _update_user_repo_params(user_name)
+      _normalize_params_keys(params)
+
+      response = if user
+        get("/users/#{user}/gists", params)
+      elsif oauth_token
+        get("/gists", params)
+      else
+        get("/gists/public", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List the authenticated user's starred gists
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.gists.starred
+    #
+    def starred(params={})
+      _normalize_params_keys(params)
+      get("/gists/starred", params)
+    end
+
+    # Get a single gist
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.gists.get_gist 'gist-id'
+    #
+    def get_gist(gist_id, params={})
+      _normalize_params_keys(params)
+      get("/gists/#{gist_id}", params)
+    end
+
+    # Create a gist
+    #
+    # = Inputs
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:public</tt>  - Required boolean
+    #  <tt>:files</tt> - Required hash - Files that make up this gist.
+    #     The key of which should be a required string filename and 
+    #     the value another required hash with parameters:
+    #        <tt>:content</tt> - Required string - File contents.
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.gists.create_gist 
+    #    'description' => 'the description for this gist',
+    #    'public' => true,
+    #    'files' => {
+    #      'file1.txt' => {
+    #         'content' => 'String file contents'
+    #       }
+    #    }
+    #
+    def create_gist(params={})
+      _normalize_params_keys(params)
+      _filter_params_keys(REQUIRED_GIST_INPUTS, params)
+
+      post("/gists", params)
+    end
+
+    # Edit a gist
+    #
+    # = Inputs
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:files</tt> - Optional hash - Files that make up this gist.
+    #     The key of which should be a optional string filename and 
+    #     the value another optional hash with parameters:
+    #        <tt>:content</tt> - Updated string - Update file contents.
+    #        <tt>:filename</tt> - Optional string - New name for this file.
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.gists.edit_gist 'gist-id', 
+    #    'description' => 'the description for this gist',
+    #    'files' => {
+    #      'file1.txt' => {
+    #         'content' => 'Updated file contents'
+    #       },
+    #      'old_name.txt' => {
+    #         'filename' => 'new_name.txt',
+    #         'content' => 'modified contents'
+    #       },
+    #      'new_file.txt' => {
+    #         'content' => 'a new file contents'
+    #       },
+    #       'delete_the_file.txt' => nil
+    #    }
+    #
+    def edit_gist(gist_id, params={})
+      _validate_presence_of(gist_id)
+      _normalize_params_keys(params)
+      _filter_params_keys(REQUIRED_GIST_INPUTS, params)
+
+      patch("/gists/#{gist_id}", params)
+    end
+
+    # Star a gist
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.gists.star 'gist-id'
+    #
+    def star(gist_id, params={})
+      _validate_presence_of(gist_id)
+      _normalize_params_keys(params)
+
+      put("/gists/#{gist_id}/star", params)
+    end
+
+    # Unstar a gist
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.gists.unstar 'gist-id'
+    #
+    def unstar_gist(gist_id, params={})
+      _validate_presence_of(gist_id)
+      _normalize_params_keys(params)
+
+      delete("/gists/#{gist_id}/star", params)
+    end
+
+    # Check if a gist is starred 
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.gists.unstar 'gist-id'
+    #
+    def starred?(gist_id, params={})
+      _validate_presence_of(gist_id)
+      _normalize_params_keys(params)
+
+      get("/gists/#{gist_id}/star", params)
+    end
+
+    # Fork a gist
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.gists.fork 'gist-id'
+    #
+    def fork(gist_id, params={})
+      _validate_presence_of(gist_id)
+      _normalize_params_keys(params)
+
+      post("/gists/#{gist_id}/fork", params)
+    end
+
+    # Delete a gist
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.gists.delete_gist 'gist-id'
+    #
+    def delete_gist(gist_id, params={})
+      _validate_presence_of(gist_id)
+      _normalize_params_keys(params)
+
+      delete("/gists/#{gist_id}", params)
+    end
+
+  end # Gists
+end # Github