github_api 0.9.1 → 0.9.2

data/lib/github_api/api.rb

@@ -77,7 +77,7 @@ module Github
     def method_missing(method, *args, &block) # :nodoc:
       case method.to_s
       when /^(.*)\?$/
-        return !self.send($1.to_s).nil?
+        return !!self.send($1.to_s)
       when /^clear_(.*)$/
         self.send("#{$1.to_s}=", nil)
       else

data/lib/github_api/arguments.rb

@@ -8,6 +8,8 @@ module Github
     include ParameterFilter
     include Validations
 
+    AUTO_PAGINATION = 'auto_pagination'.freeze
+
     # Parameters passed to request
     attr_reader :params
 
@@ -54,6 +56,7 @@ module Github
       end
       @params = options
       @remaining = extract_remaining(args)
+      extract_pagination(options)
       yield_or_eval(&block)
       self
     end
@@ -100,6 +103,14 @@ module Github
       args[required.size..-1]
     end
 
+    # Fine auto_pagination parameter in options hash
+    #
+    def extract_pagination(options)
+      if (value = options.delete(AUTO_PAGINATION))
+        api.auto_pagination = value
+      end
+    end
+
     # Remove required arguments from parameters and
     # validate their presence(if not nil or empty string).
     #

data/lib/github_api/configuration.rb

@@ -19,7 +19,8 @@ module Github
       :org,
       :login,
       :password,
-      :basic_auth
+      :basic_auth,
+      :auto_pagination
     ].freeze
 
     # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
@@ -70,6 +71,9 @@ module Github
     # By default, don't set organization name
     DEFAULT_ORG = nil
 
+    # By default, don't traverse the page links
+    DEFAULT_AUTO_PAGINATION = false
+
     attr_accessor *VALID_OPTIONS_KEYS
 
     # Convenience method to allow for global setting of configuration options
@@ -112,6 +116,7 @@ module Github
       self.login              = DEFAULT_LOGIN
       self.password           = DEFAULT_PASSWORD
       self.basic_auth         = DEFAULT_BASIC_AUTH
+      self.auto_pagination    = DEFAULT_AUTO_PAGINATION
       self
     end
 

data/lib/github_api/pagination.rb

@@ -16,6 +16,21 @@ module Github
       page_iterator.count.to_i
     end
 
+    # Iterate over results set pages by automatically calling `next_page`
+    # until all pages are exhausted. Caution needs to be exercised when
+    # using this feature - 100 pages iteration will perform 100 API calls.
+    # By default this is off. You can set it on the client, individual API
+    # instances or just per given request.
+    #
+    def auto_paginate(auto=false)
+      if current_api.auto_pagination? || auto
+        resources_bodies = []
+        each_page { |resource| resources_bodies += resource.body }
+        self.body = resources_bodies
+      end
+      self
+    end
+
     # Iterator like each for response pages. If there are no pages to
     # iterate over this method will return current page.
     def each_page

data/lib/github_api/request.rb

@@ -32,7 +32,6 @@ module Github
       if !METHODS.include?(method)
         raise ArgumentError, "unkown http method: #{method}"
       end
-      # _extract_mime_type(params, options)
 
       puts "EXECUTED: #{method} - #{path} with #{params} and #{options}" if ENV['DEBUG']
 
@@ -51,7 +50,7 @@ module Github
           request.body = extract_data_from_params(params) unless params.empty?
         end
       end
-      ResponseWrapper.new(response, self)
+      ResponseWrapper.new(response, self).auto_paginate
     end
 
     private

data/lib/github_api/response_wrapper.rb

@@ -28,10 +28,15 @@ module Github
       response.env[:url].to_s
     end
 
+    def body=(value)
+      @body = value
+      @env[:body] = value
+    end
+
     # Response raw body
     #
     def body
-      response.body
+      @body ? @body : response.body
     end
 
     # Response status
@@ -44,17 +49,33 @@ module Github
       response.success?
     end
 
+    def redirect?
+      status.to_i >= 300 && status.to_i < 400
+    end
+
+    def client_error?
+      status.to_i >= 400 && status.to_i < 500
+    end
+
+    def server_error?
+      status.to_i >= 500 && status.to_i < 600
+    end
+
     # Return response headers
     #
     def headers
       Github::Response::Header.new(env)
     end
 
-    # Lookup an attribute from the body.
+    # Lookup an attribute from the body if hash, otherwise behave like array index.
     # Convert any key to string before calling.
     #
     def [](key)
-      self.body.send(:"#{key}")
+      if self.body.is_a?(Array)
+        self.body[key]
+      else
+        self.body.send(:"#{key}")
+      end
     end
 
     # Return response body as string
@@ -86,7 +107,7 @@ module Github
     # Check if body has an attribute
     #
     def has_key?(key)
-      !self.body.is_a?(Array) && self.body.has_key?(key)
+      self.body.is_a?(Hash) && self.body.has_key?(key)
     end
 
     # Coerce any method calls for body attributes

data/lib/github_api/validations.rb

@@ -18,6 +18,7 @@ module Github
     VALID_API_KEYS = [
       'page',
       'per_page',
+      'auto_pagination',
       'jsonp_callback'
     ]
 

data/lib/github_api/version.rb

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

data/spec/coverage_adapter.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+require 'coveralls'
 
 SimpleCov.adapters.define 'github_api' do
   add_filter "/spec/"

data/spec/github/configuration_spec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Configuration do
+  let(:klass) {
+    ::Class.new do
+      extend Github::Configuration
+    end
+  }
+
+  subject { klass }
+
+  its(:adapter) { should == described_class::DEFAULT_ADAPTER }
+
+  its(:endpoint) { should == described_class::DEFAULT_ENDPOINT }
+
+  its(:site) { should == described_class::DEFAULT_SITE }
+
+  its(:user_agent) { should == described_class::DEFAULT_USER_AGENT }
+
+  its(:oauth_token) { should be_nil }
+
+  its(:auto_pagination) { should == described_class::DEFAULT_AUTO_PAGINATION }
+
+  its(:auto_pagination) { should be_false }
+
+  its(:ssl) { should == described_class::DEFAULT_SSL }
+
+  its(:ssl) { should be_a Hash }
+
+  its(:user_agent) { should == described_class::DEFAULT_USER_AGENT }
+
+  its(:repo) { should be_nil }
+
+  its(:user) { should be_nil }
+
+  its(:connection_options) { should be_a Hash }
+
+  its(:connection_options) { should be_empty }
+
+  its(:login) { should == described_class::DEFAULT_LOGIN }
+
+  its(:password) { should == described_class::DEFAULT_PASSWORD }
+
+  describe ".configure" do
+    it { should respond_to :configure }
+
+    described_class.keys.each do |key|
+      it "should set the #{key}" do
+        subject.configure do |config|
+          config.send("#{key}=", key)
+          subject.send(key).should == key
+        end
+      end
+    end
+  end
+
+end

data/spec/github/repos/pub_sub_hubbub/subscribe_spec.rb

@@ -38,10 +38,6 @@ describe Github::Repos::PubSubHubbub, '#subscribe' do
       subject.subscribe topic, callback
       a_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).should have_been_made
     end
-
-    it "" do
-      subject.subscribe(topic, callback)
-    end
   end
 
   it_should_behave_like 'request failure' do

data/spec/github_spec.rb

@@ -3,108 +3,13 @@
 require 'spec_helper'
 
 describe Github do
-
-  after do
+  after {
     subject.reset!
     reset_authentication_for subject
-  end
-
-  it "should respond to 'new' message" do
-    subject.should respond_to :new
-  end
-
-  it "should receive 'new' and initialize subject::Client instance" do
-    subject.new.should be_a Github::Client
-  end
-
-  it "should respond to 'configure' message" do
-    subject.should respond_to :configure
-  end
-
-  describe "setting configuration options" do
-    it "should return default adapter" do
-      subject.adapter.should == Github::Configuration::DEFAULT_ADAPTER
-    end
-
-    it "should allow to set adapter" do
-      subject.adapter = :typhoeus
-      subject.adapter.should == :typhoeus
-    end
-
-    it "should return the default end point" do
-      subject.endpoint.should == Github::Configuration::DEFAULT_ENDPOINT
-    end
-
-    it "should allow to set endpoint" do
-      subject.endpoint = 'http://linkedin.com'
-      subject.endpoint.should == 'http://linkedin.com'
-    end
-
-    it "should return the default user agent" do
-      subject.user_agent.should == Github::Configuration::DEFAULT_USER_AGENT
-    end
-
-    it "should allow to set new user agent" do
-      subject.user_agent = 'New User Agent'
-      subject.user_agent.should == 'New User Agent'
-    end
-
-    it "should have not set oauth token" do
-      subject.oauth_token.should be_nil
-    end
-
-    it "should allow to set oauth token" do
-      subject.oauth_token = ''
-    end
-
-    it "should have not set default user" do
-      subject.user.should be_nil
-    end
-
-    it "should allow to set new user" do
-      subject.user = 'github'
-      subject.user.should == 'github'
-    end
-
-    it "should have not set default repository" do
-      subject.repo.should be_nil
-    end
-
-    it "should allow to set new repository" do
-      subject.repo = 'github'
-      subject.repo.should == 'github'
-    end
-
-    it "should have connection options as hash" do
-      subject.connection_options.should be_a Hash
-    end
-
-    it "should initialize connection options to empty hash" do
-      subject.connection_options.should be_empty
-    end
-
-    it "shoulve have not set user's login" do
-      subject.login.should be_nil
-    end
-
-    it "should have not set user's password" do
-      subject.password.should be_nil
-    end
+  }
 
-    it "should have set mime type to json" do
-      subject.mime_type.should == :json
-    end
-  end
+  it { should respond_to :new }
 
-  describe ".configure" do
-    Github::Configuration::VALID_OPTIONS_KEYS.each do |key|
-      it "should set the #{key}" do
-        Github.configure do |config|
-          config.send("#{key}=", key)
-          Github.send(key).should == key
-        end
-      end
-    end
-  end
+  it { expect(subject.new).to be_a Github::Client }
 
 end # Github

data/spec/integration/arguments_spec.rb

@@ -72,5 +72,9 @@ describe 'Arguments' do
       subject.milestone_id.should == milestone_id
     end
 
+    it "passes through extra parameters" do
+      subject.get user, repo, milestone_id, :auto_pagination => true
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -8,8 +8,12 @@ require 'json'
 require 'webmock/rspec'
 require 'github_api'
 
-if RUBY_VERSION > '1.9' and ENV['COVERAGE']
+if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
   require 'coverage_adapter'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
   SimpleCov.start 'github_api'
   SimpleCov.coverage_dir 'coverage/rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000Z
+date: 2013-03-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2154681220 !ruby/object:Gem::Requirement
+  requirement: &2155174360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154681220
+  version_requirements: *2155174360
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2154680720 !ruby/object:Gem::Requirement
+  requirement: &2155173860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *2154680720
+  version_requirements: *2155173860
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2154680260 !ruby/object:Gem::Requirement
+  requirement: &2155173400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2154680260
+  version_requirements: *2155173400
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &2154679880 !ruby/object:Gem::Requirement
+  requirement: &2155173020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154679880
+  version_requirements: *2155173020
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2154679340 !ruby/object:Gem::Requirement
+  requirement: &2155172480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *2154679340
+  version_requirements: *2155172480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154678840 !ruby/object:Gem::Requirement
+  requirement: &2155171980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154678840
+  version_requirements: *2155171980
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2154678380 !ruby/object:Gem::Requirement
+  requirement: &2155171520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154678380
+  version_requirements: *2155171520
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2154667660 !ruby/object:Gem::Requirement
+  requirement: &2155171060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.9.0
   type: :development
   prerelease: false
-  version_requirements: *2154667660
+  version_requirements: *2155171060
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2154667200 !ruby/object:Gem::Requirement
+  requirement: &2155170600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2154667200
+  version_requirements: *2155170600
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2154666740 !ruby/object:Gem::Requirement
+  requirement: &2155170140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,21 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *2154666740
+  version_requirements: *2155170140
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: &2155169680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :development
+  prerelease: false
+  version_requirements: *2155169680
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2154666360 !ruby/object:Gem::Requirement
+  requirement: &2155169300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154666360
+  version_requirements: *2155169300
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2154665900 !ruby/object:Gem::Requirement
+  requirement: &2155168840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154665900
+  version_requirements: *2155168840
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &2154665480 !ruby/object:Gem::Requirement
+  requirement: &2155168420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154665480
+  version_requirements: *2155168420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2154665060 !ruby/object:Gem::Requirement
+  requirement: &2155168000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154665060
+  version_requirements: *2155168000
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154664640 !ruby/object:Gem::Requirement
+  requirement: &2155167580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,7 +186,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154664640
+  version_requirements: *2155167580
 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
@@ -190,6 +201,7 @@ files:
 - features/activity/notifications.feature
 - features/activity/starring.feature
 - features/activity/watching.feature
+- features/auto_pagination.feature
 - features/cassettes/activity/events/issue.yml
 - features/cassettes/activity/events/network.yml
 - features/cassettes/activity/events/org.yml
@@ -209,6 +221,8 @@ files:
 - features/cassettes/activity/watching/watch.yml
 - features/cassettes/activity/watching/watched.yml
 - features/cassettes/activity/watching/watching.yml
+- features/cassettes/auto_pagination/repos/global_list.yml
+- features/cassettes/auto_pagination/repos/list.yml
 - features/cassettes/emojis/list.yml
 - features/cassettes/errors/repos/create.yml
 - features/cassettes/gists/comments/all.yml
@@ -594,6 +608,7 @@ files:
 - spec/github/authorizations/list_spec.rb
 - spec/github/authorizations/update_spec.rb
 - spec/github/client_spec.rb
+- spec/github/configuration_spec.rb
 - spec/github/core_ext/hash_spec.rb
 - spec/github/deprecation_spec.rb
 - spec/github/error/client_error_spec.rb