github_api 0.3.9 → 0.4.0

data/spec/github/page_links_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Github::PageLinks do
+
+  let(:link) {
+    "<https://api.github.com/users/wycats/repos?page=4&per_page=20>; rel=\"next\", <https://api.github.com/users/wycats/repos?page=6&per_page=20>; rel=\"last\", <https://api.github.com/users/wycats/repos?page=1&per_page=20>; rel=\"first\", <https://api.github.com/users/wycats/repos?page=2&per_page=20>; rel=\"prev\""
+  }
+  let(:response_headers)  { { 'Link' => link } }
+
+  let(:first) { "https://api.github.com/users/wycats/repos?page=1&per_page=20" }
+  let(:last)  { "https://api.github.com/users/wycats/repos?page=6&per_page=20" }
+  let(:prev)  { "https://api.github.com/users/wycats/repos?page=2&per_page=20" }
+  let(:nexxt)  { "https://api.github.com/users/wycats/repos?page=4&per_page=20" }
+
+  context 'build page links instance' do
+
+    it 'parses first link successfully' do
+      Github::PageLinks.new(response_headers).first.should eql first
+    end
+
+    it 'parses last link successfully' do
+      Github::PageLinks.new(response_headers).last.should eql last
+    end
+
+    it 'parses next link successfully' do
+      Github::PageLinks.new(response_headers).next.should eql nexxt
+    end
+
+    it 'parses prev link successfully' do
+      Github::PageLinks.new(response_headers).prev.should eql prev
+    end
+  end
+
+end # Github::PageLinks

data/spec/github/paged_request_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Github::PagedRequest do
+
+  it { described_class.constants.should include :FIRST_PAGE }
+  it { described_class.constants.should include :PER_PAGE }
+
+  context 'page_request' do
+    let(:path) { '/repos' }
+
+    before do
+      Github.new
+    end
+
+    it 'sets default per_page when only custom page passed' do
+      Github.stub_chain(:api_client, :per_page).and_return nil
+      Github.stub_chain(:api_client, :get).and_return nil
+      Github::PagedRequest.page_request path, {'page' => 3}
+      Github::PagedRequest.page.should eq 3
+      Github::PagedRequest.per_page.should eq 25
+    end
+
+    it 'sets default page when only custom per_page passed' do
+      Github.stub_chain(:api_client, :page).and_return nil
+      Github.stub_chain(:api_client, :get).and_return nil
+      Github::PagedRequest.page_request path, {'per_page' => 33}
+      Github::PagedRequest.page.should eq 1
+      Github::PagedRequest.per_page.should eq 33
+    end
+
+    it 'sends get request with passed parameters' do
+      Github.stub(:api_client).and_return Github::Client
+      Github::Client.should_receive(:get).with(path, 'page' => 2, 'per_page' => 33)
+      Github::PagedRequest.page_request path, {'page' => 2, 'per_page' => 33}
+    end
+  end
+
+end # Github::PagedRequest

data/spec/github/response/helpers_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Github::Response::Helpers do
+
+  let(:env) { { :body => [1,2,3] } }
+  let(:instance) { described_class.new }
+
+  it 'includes result helper methods' do
+    res = instance.on_complete(env)
+    res[:body].class.included_modules.should include Github::Result
+  end
+
+  it 'should extend result with environemnt getter' do
+    res = instance.on_complete(env)
+    res[:body].should respond_to :env
+  end
+
+end # Github::Response::Helpers

data/spec/github/result_spec.rb

@@ -3,7 +3,12 @@ require 'spec_helper'
 describe Github::Result do
 
   let(:github) { Github.new }
+  let(:user)   { 'wycats' }
   let(:res)    { github.events.public }
+  let(:pages)  { ['1', '5', '6'] }
+  let(:link) {
+    "<https://api.github.com/users/wycats/repos?page=6&per_page=20>; rel=\"last\", <https://api.github.com/users/wycats/repos?page=1&per_page=20>; rel=\"first\""
+  }
 
   before do
     stub_get("/events").
@@ -12,8 +17,24 @@ describe Github::Result do
         :headers => {
           :content_type => "application/json; charset=utf-8",
           'X-RateLimit-Remaining' => '4999',
-          'content-length' => '344'
+          'X-RateLimit-Limit' => '5000',
+          'content-length' => '344',
+          'Link' => link
         })
+
+    ['1', '5', '6'].each do |page|
+    stub_get("/users/#{user}/repos").
+      with(:query => {'per_page' => '20', 'page' => page}).
+      to_return(:body => fixture('events/events.json'),
+        :status => 200,
+        :headers => {
+          :content_type => "application/json; charset=utf-8",
+          'X-RateLimit-Remaining' => '4999',
+          'X-RateLimit-Limit' => '5000',
+          'content-length' => '344',
+          'Link' => link
+        })
+    end
   end
 
   it "should read response content_type " do
@@ -24,11 +45,15 @@ describe Github::Result do
     res.content_length.should match '344'
   end
 
-  it "should read response ratelimit" do
-    res.ratelimit.should == '4999'
+  it "should read response ratelimit limit" do
+    res.ratelimit_limit.should == '5000'
+  end
+
+  it "should read response ratelimit remaining" do
+    res.ratelimit_remaining.should == '4999'
   end
 
-  it "should read response statsu" do
+  it "should read response status" do
     res.status.should be 200
   end
 
@@ -40,4 +65,42 @@ describe Github::Result do
     res.body.should_not be_empty
   end
 
+  context "pagination methods" do
+    let(:env) { {:response_headers => {}}}
+    let(:iterator) { Github::PageIterator.new(env) }
+    let(:items) { [] }
+
+    before do
+      described_class.stub(:page_iterator).and_return iterator
+      @items.stub(:env).and_return env
+    end
+
+    it "should respond to links" do
+      res.links.should be_a Github::PageLinks
+    end
+
+    %w[ next prev ].each do |link|
+      it "should return #{link} page if exists" do
+        res.send(:"#{link}_page").should eq @items
+      end
+    end
+
+    %w[ first last].each do |link|
+      it "should return #{link} page if exists" do
+        res.send(:"#{link}_page").should_not be_empty
+      end
+    end
+
+    it 'finds single page successfully' do
+      iterator.stub(:get_page).and_return res
+      res.page(5).should eq res
+    end
+
+    it 'checks if there are more pages' do
+      res.should_receive(:has_next_page?).and_return true
+      res.has_next_page?.should be_true
+    end
+
+  end # pagination
+
 end # Github::Result

data/spec/github/utils/url_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Github::Utils::Url do
+
+  it 'escapes correctly' do
+    described_class.escape('<html>').should eql '%3Chtml%3E'
+    described_class.escape('a space').should eql 'a+space'
+    described_class.escape('\\/?}!@#$%^&*()').should eql '%5C%2F%3F%7D%21%40%23%24%25%5E%26%2A%28%29'
+  end
+
+  it 'unescapes correctly' do
+    described_class.unescape('%3Chtml%3E').should eql '<html>'
+    described_class.unescape('a+space').should eql 'a space'
+    described_class.unescape('%5C%2F%3F%7D%21%40%23%24%25%5E%26%2A%28%29').should eql '\\/?}!@#$%^&*()'
+  end
+
+  context 'parses query strings correctly' do
+    it { described_class.parse_query("a=b").should eq 'a' => 'b' }
+    it { described_class.parse_query("a=b&a=c").should eq 'a' => ['b','c'] }
+    it { described_class.parse_query("a=b&c=d").should eq 'a' => 'b', 'c' => 'd' }
+    it { described_class.parse_query("a+b=%28c%29").should eq 'a b' => '(c)' }
+  end
+
+  context 'parse_query_for_param' do
+    it 'returns nil if cannot find parameter' do
+      described_class.parse_query_for_param("param1=a;param2=b", 'param3').
+        should be_nil
+    end
+
+    it 'returns value for given parameter name' do
+      described_class.parse_query_for_param("param1=a;param2=b", 'param1').
+        should eq 'a'
+    end
+  end
+
+end # Github::Utils::Url

metadata

@@ -2,7 +2,7 @@
 name: github_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-03 00:00:00 +00:00
+date: 2012-01-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.7.0
+        version: 2.8.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -124,29 +124,29 @@ dependencies:
   type: :development
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: simplecov
+  name: vcr
   prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.4"
+        version: 1.11.3
   type: :development
   version_requirements: *id011
 - !ruby/object:Gem::Dependency 
-  name: guard-rspec
+  name: simplecov
   prerelease: false
   requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "0.4"
   type: :development
   version_requirements: *id012
 - !ruby/object:Gem::Dependency 
-  name: guard-cucumber
+  name: guard-rspec
   prerelease: false
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
@@ -156,6 +156,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: guard-cucumber
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id014
 description: " Ruby wrapper that supports all of the GitHub API v3 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. "
 email: ""
 executables: []
@@ -166,9 +177,15 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
+- features/cassettes/repos/branches.yml
+- features/cassettes/repos/tags.yml
+- features/cassettes/repos/teams.yml
 - features/github_api.feature
 - features/options.feature
 - features/pagination.feature
+- features/README.rdoc
+- features/repos.feature
+- features/step_definitions/common_steps.rb
 - features/step_definitions/github_api_steps.rb
 - features/support/env.rb
 - features/support/vcr.rb
@@ -181,6 +198,7 @@ files:
 - lib/github_api/compatibility.rb
 - lib/github_api/configuration.rb
 - lib/github_api/connection.rb
+- lib/github_api/constants.rb
 - lib/github_api/core_ext/array.rb
 - lib/github_api/core_ext/hash.rb
 - lib/github_api/error.rb
@@ -202,6 +220,9 @@ files:
 - lib/github_api/orgs/members.rb
 - lib/github_api/orgs/teams.rb
 - lib/github_api/orgs.rb
+- lib/github_api/page_iterator.rb
+- lib/github_api/page_links.rb
+- lib/github_api/paged_request.rb
 - lib/github_api/pull_requests/comments.rb
 - lib/github_api/pull_requests.rb
 - lib/github_api/repos/collaborators.rb
@@ -227,6 +248,7 @@ files:
 - lib/github_api/users/followers.rb
 - lib/github_api/users/keys.rb
 - lib/github_api/users.rb
+- lib/github_api/utils/url.rb
 - lib/github_api/version.rb
 - lib/github_api.rb
 - spec/coverage_adapter.rb
@@ -304,6 +326,9 @@ files:
 - spec/github/orgs/members_spec.rb
 - spec/github/orgs/teams_spec.rb
 - spec/github/orgs_spec.rb
+- spec/github/page_iterator_spec.rb
+- spec/github/page_links_spec.rb
+- spec/github/paged_request_spec.rb
 - spec/github/repos/collaborators_spec.rb
 - spec/github/repos/commits_spec.rb
 - spec/github/repos/downloads_spec.rb
@@ -313,14 +338,16 @@ files:
 - spec/github/repos/pub_sub_hubbub_spec.rb
 - spec/github/repos/watching_spec.rb
 - spec/github/repos_spec.rb
+- spec/github/response/helpers_spec.rb
 - spec/github/result_spec.rb
 - spec/github/users_spec.rb
+- spec/github/utils/url_spec.rb
 - spec/github_spec.rb
 - spec/README.rdoc
 - spec/spec_helper.rb
 - spec/support/base.rb
 - spec/support/github_api_shared_examples.rb
-- README.rdoc
+- README.md
 - LICENSE.txt
 has_rdoc: true
 homepage: https://github.com/peter-murach/github

data/README.rdoc

@@ -1,235 +0,0 @@
-= 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'
-
-  or
-
-  @github = Github.new do |opts|
-    opts.user = 'peter-murach'
-    opts.repo = 'github-api'
-  end
-
-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.