github_api 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,4 +1,4 @@
-= github
+= github {<img src="http://travis-ci.org/peter-murach/github.png?branch=master" />}[http://travis-ci.org/peter-murach/github]
 
 A Ruby wrapper for the GitHub REST API v3.
 
@@ -8,11 +8,11 @@ Supports all the API methods(nearly 200). It's build in a modular way, that is,
 
 Grab the gem by issuing
 
-  gem install github_api --pre
+  gem install github_api
 
 or in your Gemfile
 
-  gem "github_api", "~> 0.1.0.pre"
+  gem "github_api", "~> 0.1.1"
 
 == Usage
 
@@ -20,7 +20,7 @@ Create a new client instance
 
   @github = Github.new
 
-At this stage you can also supply various configuration parameters, such as :user, :repo, :org etc..,
+At this stage you can also supply various configuration parameters, such as :user, :repo, :org, :oauth_token, :login, :password or :basic_auth
 which are used thoughtout the API
 
   @github = Github.new :user => 'peter-murach', :repo => 'github-api'
@@ -33,6 +33,13 @@ In order to authenticate the user through OAuth2 on GitHub you need to
 
 Once you have your consumer and token keys, configure your github instance following instructions under Configuration.
 
+You can also use basic authentication by passing your login and password credentials
+  @github = Github.new :login => 'peter-murach', :password => '...'
+
+  or use convenience method:
+
+  @github = Github.new :basic_auth => 'login:password'
+
 You can interact with GitHub interface, for example repositories, by issueing following calls
 
   @github.repos.commits
@@ -115,11 +122,13 @@ register an app at https://github.com/account/applications/
 
   Github.configure do |config|
     config.oauth_token   = YOUR_OAUTH_ACCESS_TOKEN
+    config.basic_auth    = 'login:password'
   end
 
 or
 
   Github.new(:oauth_token => YOUR_OAUTH_TOKEN)
+  Github.new(:basic_auth => 'login:password)
 
 All parameters can be overwirtten as per method call. By passing parameters hash...
 

data/lib/github_api.rb

@@ -50,6 +50,7 @@ module Github
     :GitData      => 'git_data',
     :Orgs         => 'orgs',
     :PullRequests => 'pull_requests',
-    :Users        => 'users'
+    :Users        => 'users',
+    :CoreExt      => 'core_ext'
 
 end # Github

data/lib/github_api/api.rb

@@ -3,6 +3,8 @@
 require 'github_api/configuration'
 require 'github_api/connection'
 require 'github_api/request'
+require 'github_api/core_ext/hash'
+require 'github_api/core_ext/array'
 
 module Github
   # @private
@@ -34,13 +36,26 @@ module Github
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
+      _process_basic_auth(options[:basic_auth])
       @cached = Hash.new
     end
 
-    private
+  private
+
+    # Extract login and password from basic_auth parameter
+    def _process_basic_auth(auth)
+      case auth
+      when String
+        login    = auth.split(':').first
+        password = auth.split(':').last
+      when Hash
+        login    = auth[:login]
+        password = auth[:password]
+      end
+    end
 
     # Responds to attribute query
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &block) # :nodoc:
       if method.to_s =~ /^(.*)\?$/
         return !self.send($1.to_s).nil?
       else
@@ -48,38 +63,38 @@ module Github
       end
     end
 
-    def _validate_inputs(required, provided)
+    def _validate_inputs(required, provided) # :nodoc:
       required.all? do |key|
         provided.has_key? key
       end
     end
 
-    def _validate_presence_of(*params)
+    def _validate_presence_of(*params) # :nodoc:
       params.each do |param|
         raise ArgumentError, "parameter cannot be nil" if param.nil?
       end
     end
 
-    def _validate_user_repo_params(user_name, repo_name)
+    def _validate_user_repo_params(user_name, repo_name) # :nodoc:
       raise ArgumentError, "[user] parameter cannot be nil" if user_name.nil?
       raise ArgumentError, "[repo] parameter cannot be nil" if repo_name.nil?
     end
 
-    def _update_user_repo_params(user_name, repo_name=nil)
+    def _update_user_repo_params(user_name, repo_name=nil) # :nodoc:
       self.user = user_name || self.user
       self.repo = repo_name || self.repo
     end
 
-    def _merge_user_into_params!(params)
+    def _merge_user_into_params!(params)  #  :nodoc:
       params.merge!({ 'user' => self.user }) if user?
     end
 
-    def _merge_user_repo_into_params!(params)
+    def _merge_user_repo_into_params!(params)   #  :nodoc:
       { 'user' => self.user, 'repo' => self.repo }.merge!(params)
     end
 
     # Turns any keys from nested hashes including nested arrays into strings
-    def _normalize_params_keys(params)
+    def _normalize_params_keys(params)  #  :nodoc:
       case params
       when Hash
         params.keys.each do |k|
@@ -96,7 +111,7 @@ module Github
       return params
     end
 
-    def _filter_params_keys(keys, params)
+    def _filter_params_keys(keys, params)  # :nodoc:
       params.reject! { |k,v| !keys.include? k }
     end
 
@@ -117,7 +132,7 @@ module Github
       return hash
     end
 
-    def _validate_params_values(options, params)
+    def _validate_params_values(options, params)  # :nodoc:
       params.each do |k, v|
         next unless options.keys.include?(k)
         if options[k].is_a?(Array) && !options[k].include?(params[k])
@@ -131,6 +146,7 @@ module Github
     def _merge_parameters(params)
     end
 
+    # TODO add to core extensions
     def _extract_parameters(array)
       if array.last.is_a?(Hash) && array.last.instance_of?(Hash)
         pop
@@ -140,9 +156,8 @@ module Github
     end
 
     # Passes configuration options to instantiated class
-    # TODO implement 
-    # @private
-    def _create_instance(klass)
+    def _create_instance(klass, options)
+      options.symbolize_keys!
       klass.new(options)
     end
 

data/lib/github_api/client.rb

@@ -4,36 +4,39 @@ module Github
   class Client < API
 
     def gists(options = {})
-      @gists ||= Github::Gists.new(options)
+      @gists ||= _create_instance Github::Gists, options
     end
 
     # The Git Database API gives you access to read and write raw Git objects
     # to your Git database on GitHub and to list and update your references
     # (branch heads and tags).
     def git_data(options = {})
-      @git_data ||= Github::GitData.new(options)
+      @git_data ||= _create_instance Github::GitData, options
     end
+    alias :git :git_data
 
     def issues(options = {})
-      @issues ||= Github::Issues.new(options)
+      @issues ||= _create_instance Github::Issues, options
     end
 
     def orgs(options = {})
-      @orgs ||= Github::Orgs.new(options)
+      @orgs ||= _create_instance Github::Orgs, options
     end
+    alias :organizations :orgs
 
     def pull_requests(options = {})
-      @pull_requests ||= Github::PullRequests.new(options)
+      @pull_requests ||= _create_instance Github::PullRequests, options
     end
 
     def repos(options = {})
-      @repos ||= Github::Repos.new(options)
+      @repos ||= _create_instance Github::Repos, options
     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 ||= Github::Users.new(options)
+      @users ||= _create_instance Github::Users, options
     end
 
   end # Client

data/lib/github_api/configuration.rb

@@ -14,7 +14,10 @@ module Github
       :user_agent,
       :faraday_options,
       :repo,
-      :user
+      :user,
+      :login,
+      :password,
+      :basic_auth
     ].freeze
 
     # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
@@ -29,6 +32,15 @@ module Github
     # By default, don't set a user oauth access token
     DEFAULT_OAUTH_TOKEN = nil
 
+    # By default, don't set a user login name
+    DEFAULT_LOGIN = nil
+
+    # By default, don't set a user password
+    DEFAULT_PASSWORD = nil
+
+    # By default, don't set a user basic authentication
+    DEFAULT_BASIC_AUTH = nil
+
     # The endpoint used to connect to GitHub if none is set
     DEFAULT_ENDPOINT = 'https://api.github.com'.freeze
 
@@ -77,6 +89,9 @@ module Github
       self.resource           = DEFAULT_RESOURCE
       self.user               = DEFAULT_USER
       self.repo               = DEFAULT_REPO
+      self.login              = DEFAULT_LOGIN
+      self.password           = DEFAULT_PASSWORD
+      self.basic_auth         = DEFAULT_BASIC_AUTH
       self
     end
 

data/lib/github_api/connection.rb

@@ -6,6 +6,7 @@ require 'github_api/response/mashify'
 require 'github_api/response/jsonize'
 require 'github_api/response/raise_error'
 require 'github_api/request/oauth2'
+require 'github_api/request/basic_auth'
 
 module Github
   module Connection
@@ -73,6 +74,7 @@ module Github
           builder.use Faraday::Response::Logger
 
           builder.use Github::Request::OAuth2, oauth_token if oauth_token?
+          builder.use Github::Request::BasicAuth, login, password if login? && password?
 
           unless options[:raw]
             builder.use Github::Response::Mashify
@@ -83,7 +85,6 @@ module Github
           builder.adapter adapter
         end
       end
-
     end
 
   end # Connection

data/lib/github_api/core_ext/array.rb

@@ -0,0 +1,14 @@
+class Array # :nodoc:
+
+  def except(*keys) # :nodoc:
+    puts "module except works!!!"
+    self.dup.except!(*keys)
+  end unless method_defined?(:except)
+
+  def except!(*items) # :nodoc:
+    copy = self.dup
+    copy.reject! { |item| items.include? item }
+    copy
+  end unless method_defined?(:except!)
+
+end # Hash

data/lib/github_api/core_ext/hash.rb

@@ -0,0 +1,38 @@
+class Hash # :nodoc:
+
+  def except(*items) # :nodoc:
+    puts "array except works!!!"
+    self.dup.except!(*items)
+  end unless method_defined?(:except)
+
+  def except!(*keys) # :nodoc:
+    copy = self.dup
+    keys.each { |key| copy.delete!(key) }
+    copy
+  end unless method_defined?(:except!)
+
+  def symbolize_keys  # :nodoc:
+    inject({}) do |hash, (key, value)|
+      hash[(key.to_sym rescue key) || key] = value
+      hash
+    end
+  end
+
+  def symbolize_keys! # :nodoc:
+    hash = symbolize_keys
+    hash.each do |key, val|
+      hash[key] = case val
+        when Hash
+          val.symbolize_keys!
+        when Array
+          val.map do |item|
+            item.is_a?(Hash) ? item.symbolize_keys! : item
+          end
+        else
+          val
+        end
+    end
+    return hash
+  end unless method_defined?(:symbolize_keys!)
+
+end # Hash

data/lib/github_api/repos.rb

@@ -42,7 +42,7 @@ module Github
 
     VALID_REPO_TYPES = %w[ all public private member ]
 
-    # Creates new Repos API
+    # Creates new Repositories API
     def initialize(options = {})
       super(options)
     end
@@ -60,11 +60,13 @@ module Github
     def branches(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless (user? && repo?)
+      _normalize_params_keys(params)
 
       response = get("/repos/#{user}/#{repo}/branches", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_branches :branches
 
     # Create a new repository for the autheticated user.
     #
@@ -79,14 +81,20 @@ module Github
     #
     # = Examples
     #  @github = Github.new
-    #  @github.repos.create_repo :name => 'my_repo_name'
+    #  @github.repos.create_repo "name" => 'repo-name'
+    #    "description": "This is your first repo",
+    #    "homepage": "https://github.com",
+    #    "public": true,
+    #    "has_issues": true,
+    #    "has_wiki": true,
+    #    "has_downloads": true
     #
-    # Create a new repository in this organisation. The authenticated user 
+    # Create a new repository in this organisation. The authenticated user
     # must be a member of this organisation
     #
     # Examples:
     #   @github = Github.new :oauth_token => '...'
-    #   @github.repos.create_repo(:name => 'my-repo-name', :org => 'my-organisation')
+    #   @github.repos.create_repo :name => 'repo-name', :org => 'organisation-name'
     #
     def create_repo(*args)
       params = args.last.is_a?(Hash) ? args.pop : {}
@@ -102,6 +110,7 @@ module Github
         post("/user/repos", DEFAULT_REPO_OPTIONS.merge(params))
       end
     end
+    alias :create_repository :create_repo
 
     # List contributors
     #
@@ -111,8 +120,8 @@ module Github
     # = Examples
     #
     #  @github = Github.new
-    #  @github.repos.contributors('user-name','repo-name')
-    #  @github.repos.contributors('user-name','repo-name') { |cont| ... }
+    #  @github.repos.contributors 'user-name','repo-name'
+    #  @github.repos.contributors 'user-name','repo-name' { |cont| ... }
     #
     def contributors(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)
@@ -124,6 +133,8 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_contributors :contributors
+    alias :contribs :contributors
 
     # Edit a repository
     #
@@ -141,7 +152,7 @@ module Github
     #  @github = Github.new
     #  @github.repos.edit_repo('user-name', 'repo-name', { :name => 'hello-world', :description => 'This is your first repo', :homepage => "https://github.com", :public => true, :has_issues => true })
     #
-    def edit_repo(user=nil, repo=nil, params={})
+    def edit_repo(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
@@ -152,6 +163,7 @@ module Github
 
       patch("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
     end
+    alias :edit_repository :edit_repo
 
     # Get a repository
     #
@@ -166,6 +178,8 @@ module Github
 
       get("/repos/#{user}/#{repo}", params)
     end
+    alias :get_repository :get_repo
+
 
     # List languages
     #
@@ -183,40 +197,48 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_languages :languages
 
     # List repositories for the authenticated user
     #
     # = Examples
-    #   @github = Github.new { :consumer_key => ... }
+    #   @github = Github.new :oauth_token => '...'
     #   @github.repos.list_repos
+    #   @github.repos.list_repos { |repo| ... }
     #
     # List public repositories for the specified user.
     #
     # = Examples
     #   github = Github.new
-    #   github.repos.list_repos(:user => 'user-name')
+    #   github.repos.list_repos :user => 'user-name'
+    #   github.repos.list_repos :user => 'user-name', { |repo| ... }
     #
     # List repositories for the specified organisation.
     #
     # = Examples
     #  @github = Github.new
-    #  @github.repos.list_repos(:org => 'org-name')
+    #  @github.repos.list_repos :org => 'org-name'
+    #  @github.repos.list_repos :org => 'org-name', { |repo| ... }
     #
-    def list_repos(*args)
+    def repos(*args)
       params = args.last.is_a?(Hash) ? args.pop : {}
       _normalize_params_keys(params)
-      _merge_user_into_params!(params) unless params.has_key?('user')
+      # _merge_user_into_params!(params) unless params.has_key?('user')
       _filter_params_keys(%w[ org user type ], params)
 
-      if (user_name = params.delete("user"))
+      response = if (user_name = params.delete("user"))
         get("/users/#{user_name}/repos")
       elsif (org_name = params.delete("org"))
-        get("/users/#{org_name}/repos", params)
+        get("/orgs/#{org_name}/repos", params)
       else
         # For authenticated user
         get("/user/repos", params)
       end
+      return response unless block_given?
+      response.each { |el| yield el }
     end
+    alias :list_repos :repos
+    alias :list_repositories :repos
 
     # List tags
     #
@@ -234,6 +256,9 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_tags :tags
+    alias :repo_tags :tags
+    alias :repository_tags :tags
 
     # List teams
     #
@@ -251,6 +276,9 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_teams :teams
+    alias :repo_teams :teams
+    alias :repository_teams :teams
 
   end # Repos
 end # Github