github_api 0.9.5 → 0.9.6

data/README.md

@@ -20,12 +20,12 @@ Supports all the API methods(nearly 200). It's build in a modular way, that is,
 * Fully customizable including advanced middleware stack construction.
 * Its comprehensive, you can request all GitHub API resources.
 * Flexible arguments parsing, you can write expressive and natural queries.
-* Requests pagination with convenient DSL.
+* Requests pagination with convenient DSL and automatic option.
 * Easy error handling split for client and server type errors.
 * Supports multithreaded environment.
 * Custom mime types specification (Status: In Progess)
 * Request results caching (Status: TODO)
-* Fully tested with test coverage above 90% with over 1,500 specs and 700 features.
+* Fully tested with test coverage above 90% with over 1,500 specs and 800 features.
 
 ## Installation
 

data/features/auto_pagination.feature

@@ -2,7 +2,7 @@ Feature: Github API auto pagination
 
   The gem permits to auto paginate resources.
 
-  Scenario: Passing auto_pagionation param to instances
+  Scenario: Passing auto_pagionation param to request
 
     Given I have "Github::Repos" instance
     When I want to list resources
@@ -26,3 +26,14 @@ Feature: Github API auto pagination
       And the response type should be JSON
       And the response should have 134 items
 
+  Scenario: Paginating single resource
+
+    Given I have "Github::Repos" instance
+      And I pass the following request options:
+        | user   | repo |  auto_pagination |
+        | wycats | thor | true            |
+    When I want to get resource
+      And I make request within a cassette named "auto_pagination/repos/get"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response body name should be thor

data/features/cassettes/auto_pagination/repos/get.yml

@@ -0,0 +1,86 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/repos/wycats/thor?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3.full+json,application/vnd.github.beta.full+json;q=0.7,application/vnd.github+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.9.5
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 06 Apr 2013 19:45:34 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4995'
+      Vary:
+      - Accept, Authorization, Cookie
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      Last-Modified:
+      - Sat, 06 Apr 2013 17:25:26 GMT
+      Etag:
+      - ! '"19532db9c9ae7284243986dd05c79ea6"'
+      X-Github-Media-Type:
+      - github.v3; param=full; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA51Yy46rOBD9lQhpVpPEhM6jG2l0ZzbzAaOezWwiBxywGgyy
+        TUdp1P8+pwwEOrnqXGeT8KhzfFwuu6poA5kG8WoTbXbzQPFSBHFg80oH8+DY
+        FMW+f3Q6J9wa1r+pTkroIG6DosqkAqJ7DQyRrecBf+eW632jC7zMra1NzJgR
+        SaPFMtPd22VSlay7ZOvoebXd8SeR7KLoaXPgL7vVahu9ROv1S7QNX36kfwws
+        PFo/L8WSv/GSy6USlnFjhDXLTNq8ORDrb9HfsuSZMLgYRpteLxoj9GIdhcta
+        ZRA92OxJfXBPCwBf58VrORmcEblhF4/ktiyuHDEqHc2OVVFUJyCvbL8hZxcM
+        LZbDS5V544EhH0hjfcZ29i2jP7jtEwwGK65F6jF+j2iZi6fPlmlRV46qOZhE
+        y9rKSvmI+oIDT6UzruQH9+UBzgBOcnyGd/bAiXehvJzZAVpWa/nOkzO5QItE
+        yHe405vsCgkue65pW/+LwAw+54EbxeLJkRdGzLE/70fosPNTcVkYMP416+9U
+        NjtqHB6nSr/NbM7tDL4oeCLMTPM3MeMqnRlcQMwRJpehv91Izp39DhnGJ/Sd
+        JbmBYZ8AhKHfxNkbS5iW4beP8gT7jB8qzW11b6/eCvkCbtn0ltbcCl56C3Qg
+        gPOq8veMAwEsjWnEL4Xa7aQc1rAhhlVTHrCZf3Eb3NJ1PIDjWJeZEsLbIxdg
+        685iknLQXCW5P9WAa1l35VaJZ96SCNMy/DoxRXXwZkDOYA7YMpNzosGT/SNa
+        iKnTMyHS4viQJMJdFFn9wGo5OQS80CAtWCyct54Bx9p+YgVXWUN1wPc56TYG
+        L0C4mZJUxj/uZuZblhEJmqRSVstD89ixMWJJUZcdscu8JzaBjkQuzfq6aJpq
+        3fTKUt7Lebcu6mFfYvpBKoqjazq6v5+Kfy6LcC0bT7PuiOwZfb3Vn5GDHtaO
+        vBQYj2nscKz9veY2pxMB9DXXwldcD2PtgRvxuVwu21xwV9KVQj+wezoU4Fwn
+        OWoYXz3tgEPeLrl1deGR5KSoE4uKp95hfwGCpFsKX00dahoPNbojbyEONGUp
+        ZSGMrZT/GTUip3yqsvIo0avdr5xvw/4LuP1hpErEnBfFHFFlZSIRZ2gWaCVQ
+        Agn/2XcoyEWl6OJVC9Sh6Z5b1JJRGD4vws0i3L1GYRzu4qfVf7Bp6nRqs3pa
+        hOtFuH1d7eJoE0dbsqkbk480vcnmdbWJ12AKyYSSZVds4gq96E0L5gpMauNg
+        bEw+Gv85msaTLrg3TQqs3VUwfc/9fn3U/twcMvKqFDXSV99CQ/XpdFqeRd6k
+        6H7tB7W6pFZ+wGS9iebBiVtUOUgLSdUoOHW1XYe0WF0aBM8/zeFMzNzsu4gO
+        Yqsb6gHwZNwlk4cn+SYHo6747rmjEH1+KbWu+j5fIbbRctVC9dyDih00dCV4
+        7EATkyCml4PsQXAqjrwp7L6ruSC75Maid8FKC11COAU3fX7gaUmfH/o+hsJg
+        clPg2wNNDh0PvhJQZzIIgorP/wHunZF3+BAAAA==
+    http_version: !!null 
+  recorded_at: Sat, 06 Apr 2013 19:45:34 GMT
+recorded_with: VCR 2.4.0

data/features/step_definitions/common_steps.rb

@@ -80,6 +80,10 @@ Then /^the response (.*) link should contain:$/ do |type, table|
   end
 end
 
+Then /^the response body (.*) should be (.*)$/ do |attr, result|
+  expect(@response.body[attr]).to eql result
+end
+
 Then /^the response (.*) item (.*) should be (.*)$/ do |action, field, result|
   if action == 'first'
     @response.first.send(field).should eql result

data/lib/github_api/issues.rb

@@ -12,20 +12,21 @@ module Github
       :Milestones => 'milestones'
 
     VALID_ISSUE_PARAM_NAMES = %w[
+      assignee
+      body
+      creator
+      direction
       filter
-      state
       labels
-      sort
-      direction
-      since
       milestone
-      assignee
       mentioned
-      title
-      body
-      resource
       mime_type
       org
+      resource
+      since
+      sort
+      state
+      title
     ].freeze
 
     VALID_ISSUE_PARAM_VALUES = {
@@ -108,6 +109,7 @@ module Github
     #  * String User login
     #  * <tt>none</tt> for Issues with no assigned User.
     #  * <tt>*</tt>    for Issues with any assigned User.
+    # <tt>:creator</tt> String User login
     # <tt>:mentioned</tt> String User login
     # <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>,
     #                  default: <tt>created</tt>

data/lib/github_api/pagination.rb

@@ -23,7 +23,7 @@ module Github
     # instances or just per given request.
     #
     def auto_paginate(auto=false)
-      if current_api.auto_pagination? || auto
+      if (current_api.auto_pagination? || auto) && self.body.is_a?(Array)
         resources_bodies = []
         each_page { |resource| resources_bodies += resource.body }
         self.body = resources_bodies

data/lib/github_api/repos/forks.rb

@@ -25,12 +25,12 @@ module Github
     # Create a fork for the authenticated user
     #
     # = Inputs
-    # * <tt>:org</tt> - Optional string - the name of the service that is being called.
+    # * <tt>:organization</tt> - Optional string - the name of the service that is being called.
     #
     # = Examples
     #  github = Github.new
     #  github.repos.forks.create 'user-name', 'repo-name',
-    #    "org" =>  "github"
+    #    "organization" => "github"
     #
     def create(*args)
       arguments(args, :required => [:user, :repo])

data/lib/github_api/repos/hooks.rb

@@ -56,12 +56,12 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.hooks.get 'user-name', 'repo-name'
+    #  github.repos.hooks.get 'user-name', 'repo-name', 'hook-id'
     #
     def get(*args)
-      arguments(args, :required => [:user, :repo, :hook_id])
+      arguments(args, :required => [:user, :repo, :id])
 
-      get_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", arguments.params)
+      get_request("/repos/#{user}/#{repo}/hooks/#{id}", arguments.params)
     end
     alias :find :get
 
@@ -104,7 +104,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.hooks.edit 'user-name', 'repo-name',
+    #  github.repos.hooks.edit 'user-name', 'repo-name', 'hook-id',
     #    "name" => "campfire",
     #    "active" =>  true,
     #    "config" =>  {
@@ -114,12 +114,12 @@ module Github
     #    }
     #
     def edit(*args)
-      arguments(args, :required => [:user, :repo, :hook_id]) do
+      arguments(args, :required => [:user, :repo, :id]) do
         sift VALID_HOOK_PARAM_NAMES, :recursive => false
         assert_required REQUIRED_PARAMS
       end
 
-      patch_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", arguments.params)
+      patch_request("/repos/#{user}/#{repo}/hooks/#{id}", arguments.params)
     end
 
     # Test a hook
@@ -131,10 +131,10 @@ module Github
     #  github.repos.hooks.test 'user-name', 'repo-name', 'hook-id'
     #
     def test(*args)
-      arguments(args, :required => [:user, :repo, :hook_id])
+      arguments(args, :required => [:user, :repo, :id])
       params = arguments.params
 
-      post_request("/repos/#{user}/#{repo}/hooks/#{hook_id}/test", params)
+      post_request("/repos/#{user}/#{repo}/hooks/#{id}/test", params)
     end
 
     # Delete a hook
@@ -144,10 +144,10 @@ module Github
     #  github.repos.hooks.delete 'user-name', 'repo-name', 'hook-id'
     #
     def delete(*args)
-      arguments(args, :required => [:user, :repo, :hook_id])
+      arguments(args, :required => [:user, :repo, :id])
       params = arguments.params
 
-      delete_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
+      delete_request("/repos/#{user}/#{repo}/hooks/#{id}", params)
     end
 
   end # Repos::Hooks

data/lib/github_api/request.rb

@@ -9,7 +9,7 @@ module Github
     METHODS_WITH_BODIES = [ :post, :put, :patch ]
 
     def get_request(path, params={}, options={})
-      request(:get, path, params, options)
+      request(:get, path, params, options).auto_paginate
     end
 
     def patch_request(path, params={}, options={})
@@ -50,7 +50,7 @@ module Github
           request.body = extract_data_from_params(params) unless params.empty?
         end
       end
-      ResponseWrapper.new(response, self).auto_paginate
+      ResponseWrapper.new(response, self)
     end
 
     private

data/lib/github_api/version.rb

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

data/spec/github/request_spec.rb

@@ -2,15 +2,15 @@
 
 require 'spec_helper'
 
-
 describe Github::Request do
   let(:github) { Github::API.new  }
   let(:path) { 'github.api/repos/users' }
   let(:params) { {} }
   let(:options) { {} }
+  let(:response) { double('response').as_null_object }
 
   it "knows how to make get request" do
-    github.should_receive(:request).with(:get, path, params, options)
+    github.should_receive(:request).with(:get, path, params, options) { response }
     github.get_request path, params, options
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000Z
+date: 2013-04-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2160880680 !ruby/object:Gem::Requirement
+  requirement: &2154609900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2160880680
+  version_requirements: *2154609900
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2160880120 !ruby/object:Gem::Requirement
+  requirement: &2154609200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160880120
+  version_requirements: *2154609200
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2160879660 !ruby/object:Gem::Requirement
+  requirement: &2154608740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2160879660
+  version_requirements: *2154608740
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &2160879260 !ruby/object:Gem::Requirement
+  requirement: &2154608360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160879260
+  version_requirements: *2154608360
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2160878720 !ruby/object:Gem::Requirement
+  requirement: &2154607760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *2160878720
+  version_requirements: *2154607760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160878220 !ruby/object:Gem::Requirement
+  requirement: &2154607260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160878220
+  version_requirements: *2154607260
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2160877760 !ruby/object:Gem::Requirement
+  requirement: &2154606800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160877760
+  version_requirements: *2154606800
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2160877300 !ruby/object:Gem::Requirement
+  requirement: &2154606340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.9.0
   type: :development
   prerelease: false
-  version_requirements: *2160877300
+  version_requirements: *2154606340
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2160876840 !ruby/object:Gem::Requirement
+  requirement: &2154605880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2160876840
+  version_requirements: *2154605880
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2160876380 !ruby/object:Gem::Requirement
+  requirement: &2154605420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *2160876380
+  version_requirements: *2154605420
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: &2160875900 !ruby/object:Gem::Requirement
+  requirement: &2154604960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.5.8
   type: :development
   prerelease: false
-  version_requirements: *2160875900
+  version_requirements: *2154604960
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2160875500 !ruby/object:Gem::Requirement
+  requirement: &2154604560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160875500
+  version_requirements: *2154604560
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2160875040 !ruby/object:Gem::Requirement
+  requirement: &2154604060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160875040
+  version_requirements: *2154604060
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &2160874620 !ruby/object:Gem::Requirement
+  requirement: &2154603540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160874620
+  version_requirements: *2154603540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160874200 !ruby/object:Gem::Requirement
+  requirement: &2154603000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160874200
+  version_requirements: *2154603000
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160873780 !ruby/object:Gem::Requirement
+  requirement: &2154602420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,7 +186,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160873780
+  version_requirements: *2154602420
 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
@@ -225,6 +225,7 @@ files:
 - features/cassettes/arguments/orgs/get.yml
 - features/cassettes/arguments/pulls/get.yml
 - features/cassettes/arguments/repo_commits/get.yml
+- features/cassettes/auto_pagination/repos/get.yml
 - features/cassettes/auto_pagination/repos/global_list.yml
 - features/cassettes/auto_pagination/repos/list.yml
 - features/cassettes/emojis/list.yml