github_api 0.3.5 → 0.3.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Piotr Murach
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,228 @@
+= GithubAPI {<img src="http://travis-ci.org/peter-murach/github.png?branch=master" />}[http://travis-ci.org/peter-murach/github] {<img src="https://gemnasium.com/peter-murach/github.png?travis" />}[https://gemnasium.com/peter-murach/github]
+
+Wiki[https://github.com/peter-murach/github/wiki] | RDocs[http://rubydoc.info/github/peter-murach/github/master/frames]
+
+A Ruby wrapper for the GitHub REST API v3.
+
+Supports all the API methods(nearly 200). It's build in a modular way, that is, you can either instantiate the whole api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely with repositories is your main concern.
+
+== Installation
+
+Grab the gem by issuing
+
+  gem install github_api
+
+or in your Gemfile
+
+  gem "github_api"
+
+== Usage
+
+Create a new client instance
+
+  @github = Github.new
+
+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 throughout the API
+
+  @github = Github.new :user => 'peter-murach', :repo => 'github-api'
+
+You can authenticate either using OAuth authentication convenience methods(see section OAuth) or through 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
+  @github.repos.branches
+  @github.repos.contributors
+
+The code base is modular and allows for you to work specifically with a given part of GitHub API e.g. repositories
+
+  @repos = Github::Repos.new
+  @repos.branches 'peter-murach', 'github'
+
+or
+
+  @repos = Github::Repos.new :user => 'peter-murach', :repo => 'github'
+  @repos.branches
+
+The response is of type [Hashie::Mash] and allows to traverse all the json response attributes like method calls e.i.
+
+  @repos = Github::Repos.new :user => 'peter-murach', :repo => 'github'
+  @repos.branches do |branch|
+    puts branch.name
+  end
+
+== API
+
+Main API methods are grouped into the following classes that can be instantiated on their own
+
+  Github         - full API access
+  Github::Gists
+  Github::GitData
+  Github::Issues
+  Github::Orgs
+  Github::PullRequests
+  Github::Repos
+  Github::Users
+  Github::Events
+  Github::Authorizations
+
+Some parts of GitHub API v3 require you to be autheticated, for instance the following are examples of APIs only for the authenticated user
+
+  Github::Users::Emails
+  Github::Users::Keys
+
+All method calls form ruby like sentences and allow for intuitive api navigation, for instance
+
+  @github = Github.new :oauth_token => '...'
+  @github.users.following 'wycats'  # => returns users that 'wycats' is following
+  @github.users.following 'wycats' # => returns true if following, otherwise false
+
+For specification on all available methods go to http://developer.github.com/v3/ or
+read the rdoc, all methods are documented there with examples of usage.
+
+== Inputs
+
+Some API methods apart from required parameters such as username, repository name
+or organisation name, allow you to switch the way the data is returned to you, for instance
+
+  @github = Github.new
+  @github.git_data.tree 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea' # => gets a tree
+
+  @github.git_data.tree 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea', :recursive => true # => gets a whole tree recursively
+
+  by passing a block you can iterate over the file tree
+
+  @github.git_data.tree 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea', :recursive => true do |file|
+    puts file.path
+  end
+
+== OAuth
+
+In order to authenticate the user through OAuth2 on GitHub you need to
+
+* visit https://github.com/account/applications/ and register your app
+
+* authorize your credentials https://github.com/login/oauth/authorize
+  You can use convenience methods to help you achieve this that come with this gem:
+
+    @github = Github.new :client_id => '...', :client_secret => '...'
+    @github.authorize_url :redirect_uri => 'http://localhost', :scope => 'repo'
+    # => "https://github.com/login/oauth/authorize?scope=repo&response_type=code&client_id='...'&redirect_uri=http%3A%2F%2Flocalhost"
+
+    After you get your authorization code, call to receive your access_token
+
+    token = github.get_token( authorization_code )
+
+Once you have your access token, configure your github instance following instructions under Configuration.
+
+Alternatively you can use OAuth Authorizations API. For instance, to create access token through GitHub API do following
+
+  @github = Github.new :basic_auth => 'login:password'
+  @github.oauth.create_authorization 'scopes' => ['repo']
+
+You can add more than one scope from the <tt>user</tt>, <tt>public_repo</tt>, <tt>repo</tt>, <tt>gist</tt> or leave the scopes parameter out, in which case, the default read-only access will be assumed(includes public user profile info, public repo info, and gists).
+
+== MIME Types
+
+Issues, PullRequests and few other API leverage custom mime types which are <tt>:json</tt>, <tt>:blob</tt>, <tt>:raw</tt>, <tt>:text</tt>, <tt>:html</tt>, <tt>:full</tt>. By default <tt>:raw</tt> is used.
+
+In order to pass a mime type with your request do
+
+  @github = Github.new
+  @github.pull_requests.pull_requests 'peter-murach', 'github', :mime_type => :full
+
+  Your header will contain 'Accept: "application/vnd.github-pull.full+json"' which in turn returns raw, text and html representations in response body.
+
+== Configuration
+
+Certain methods require authentication. To get your GitHub OAuth v2 credentials,
+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...
+
+== Caching
+
+Each <tt>get</tt> request by default is not going to be cached. In order to set the cache do... If no cache type is provided a default memoization is done.
+
+  Github.cache do...
+
+== Examples
+
+Some api methods require input parameters, these are added simply as a hash properties, for instance
+
+  @issues = Github::Issues.new :user => 'peter-murach', :repo => 'github-api'
+  @issues.milestones :state => 'open', :sort => 'due_date', :direction => 'asc'
+
+Other methods may require inputs as an array of strings
+
+  @users = Github::Users.new :oauth_token => '...'
+  @users.add_email 'email1', 'email2', ..., 'emailn' # => Adds emails to the authenticated user
+
+If a method returns a collection, you can iterator over it by supplying a block parameter,
+
+  @issues = Github::Issues.new :user => 'peter-murach', :repo => 'github-api'
+  @issues.events do |event|
+    puts event.actor.login
+  end
+
+Query requests instead of http responses return boolean values
+
+  @github = Github.new
+  @github.orgs.public_member? 'github', 'technoweenie' # => true
+
+== Rails Example
+
+A Rails controller that allows a user to authorize their GitHub account and then perform request.
+
+  class GithubController < ApplicationController
+
+    def authorize
+      github = Github.new :client_id => '...', :client_secret => '...'
+      address = github.authorize_url :redirect_uri => 'http://...', :scope => 'repo'
+      redirect_to address
+    end
+
+    def callback
+      authorization_code = params[:code]
+      token = github.get_token authorization_code
+      access_token = token.token
+    end
+  end
+
+== TODO
+
+* Add request caching - local filestore?, http caching?.
+* Add response processing methods
+* Add response set helper methods e.i. pagination.
+* Add DSL falvoured api access
+
+== Contributing to github
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Piotr Murach. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "github"
+  gem.homepage = "http://github.com/peter-murach/github"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = ""
+  gem.authors = ["Piotr Murach"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "github #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/features/github_api.feature

@@ -0,0 +1,50 @@
+Feature: Github API components
+
+  In order to interact with full Github API
+  A user needs to request a Github class instance
+
+  Scenario: Accessing repositories API
+    Given I have github instance
+    When  I fetch "repos"
+    Then  I will have access to "Github::Repos" API
+
+  Scenario: Accessing organizations API
+    Given I have github instance
+    When  I fetch "orgs"
+    Then  I will have access to "Github::Orgs" API
+
+  Scenario: Accessing gists API
+    Given I have github instance
+    When  I fetch "gists"
+    Then  I will have access to "Github::Gists" API
+
+  Scenario: Accessing issues API
+    Given I have github instance
+    When  I fetch "issues"
+    Then  I will have access to "Github::Issues" API
+
+  Scenario: Accessing pull requests API
+    Given I have github instance
+    When  I fetch "pull_requests"
+    Then  I will have access to "Github::PullRequests" API
+
+  Scenario: Accessing git data API
+    Given I have github instance
+    When  I fetch "git_data"
+    Then  I will have access to "Github::GitData" API
+
+  Scenario: Accessing users API
+    Given I have github instance
+    When  I fetch "users"
+    Then  I will have access to "Github::Users" API
+
+  Scenario: Accessing users API
+    Given I have github instance
+    When  I fetch "events"
+    Then  I will have access to "Github::Events" API
+
+  Scenario: Accessing authorizations API
+    Given I have github instance
+    When  I fetch "oauth"
+    Then  I will have access to "Github::Authorizations" API
+

data/features/options.feature

@@ -0,0 +1,4 @@
+Feature: Github API options setting
+  In order to customize options used
+  As a user
+  I want to be able to set them easily

data/features/pagination.feature

@@ -0,0 +1,4 @@
+Feature: Githu API pagination
+  In order to paginate number of received records
+  As a user
+  I want to be able to view them in butches

data/features/step_definitions/github_api_steps.rb

@@ -0,0 +1,11 @@
+Given /^I have github instance$/ do
+  @github = Github.new
+end
+
+When /^I fetch "([^"]*)"$/ do |method|
+  @response = @github.send(method.to_sym)
+end
+
+When /^I will have access to "([^"]*)" API$/ do |api|
+  @response.class.to_s.should match api
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'github_api'
+
+require 'rspec/expectations'

data/lib/github_api.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require 'github_api/version'
+require 'github_api/configuration'
+require 'github_api/connection'
+
+module Github
+  extend Configuration
+
+  class << self
+    # Alias for Github::Client.new
+    #
+    # @return [Github::Client]
+    def new(options = {})
+      Github::Client.new(options)
+    end
+
+    # Delegate to Github::Client
+    #
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+
+  module AutoloadHelper
+
+    def autoload_all(prefix, options)
+      options.each do |const_name, path|
+        autoload const_name, File.join(prefix, path)
+      end
+    end
+
+    def register_constant(options)
+      options.each do |const_name, value|
+        const_set const_name.upcase.to_s, value
+      end
+    end
+
+    def lookup_constant(const_name)
+      const_get const_name.upcase.to_s
+    end
+
+  end
+
+  extend AutoloadHelper
+
+  autoload_all 'github_api',
+    :API          => 'api',
+    :Client       => 'client',
+    :Repos        => 'repos',
+    :Request      => 'request',
+    :Response     => 'response',
+    :Result       => 'result',
+    :Error        => 'error',
+    :Issues       => 'issues',
+    :Gists        => 'gists',
+    :GitData      => 'git_data',
+    :Orgs         => 'orgs',
+    :PullRequests => 'pull_requests',
+    :Users        => 'users',
+    :Events       => 'events',
+    :CoreExt      => 'core_ext',
+    :MimeType     => 'mime_type',
+    :Authorization => 'authorization',
+    :Authorizations => 'authorizations'
+
+end # Github