github_api 0.4.0 → 0.4.1

data/features/pagination.feature

@@ -2,3 +2,9 @@ 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
+
+  Scenario: Re
+    Given I have "Github::Repos" instance
+    And I am looking for "repos" with the following params:
+      | page | per_page | 
+    And I make request within a cassette named "repos"

data/lib/github_api/api.rb

@@ -7,6 +7,7 @@ require 'github_api/mime_type'
 require 'github_api/core_ext/hash'
 require 'github_api/core_ext/array'
 require 'github_api/compatibility'
+require 'github_api/api/actions'
 
 module Github
 

data/lib/github_api/api/actions.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module Github
+  class API
+
+    # Returns all API public methods for a given class.
+    def self.inherited(klass)
+      klass.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def self.actions
+          self.new.api_methods_in(#{klass})
+        end
+        def actions
+          api_methods_in(#{klass})
+        end
+      RUBY_EVAL
+      super
+    end
+
+    def api_methods_in(klass)
+      puts "---"
+      (klass.send(:instance_methods, false) - ['actions']).sort.each do |rest_met|
+        puts "|--> #{rest_met}"
+      end
+      klass.included_modules.each do |mod|
+        if mod.to_s =~ /#{klass}/
+          puts "| \\ #{mod.to_s}"
+          mod.instance_methods(false).each do |met|
+            puts "|  |--> #{met}"
+          end
+          puts "| /"
+        end
+      end
+      puts "---"
+      nil
+    end
+
+  end # API
+end # Github

data/lib/github_api/paged_request.rb

@@ -4,9 +4,11 @@ module Github
 
     extend self
 
-    FIRST_PAGE = 1
+    FIRST_PAGE = 1 # Default request page if none provided
 
-    PER_PAGE = 25
+    PER_PAGE   = 30 # Default number of items as specified by API
+
+    NOT_FOUND  = -1 # Either page or per_page parameter not present
 
     class << self
       attr_accessor :page, :per_page
@@ -21,8 +23,12 @@ module Github
     end
 
     def page_request(path, params={})
-      params[PARAM_PER_PAGE] = default_page_size unless params[PARAM_PER_PAGE]
-      params[PARAM_PAGE] = default_page unless params[PARAM_PAGE]
+      if params[PARAM_PER_PAGE] == NOT_FOUND
+        params[PARAM_PER_PAGE] = default_page_size
+      end
+      if !params[PARAM_PAGE] || params[PARAM_PAGE] == NOT_FOUND
+        params[PARAM_PAGE] = default_page
+      end
 
       Github::PagedRequest.page = params[PARAM_PAGE]
       Github::PagedRequest.per_page = params[PARAM_PER_PAGE]

data/lib/github_api/version.rb

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

data/spec/github/api_spec.rb

@@ -3,23 +3,52 @@ require 'spec_helper'
 describe Github::API do
 
   let(:api) { Github::API.new }
+  let(:repos) { Github::Repos }
 
-  before(:each) do
-    @params = { 'a' => { :b => { 'c' => 1 }, 'd' => [ 'a', { :e => 2 }] } }
+  it { described_class.included_modules.should include Github::Authorization }
+  it { described_class.included_modules.should include Github::MimeType }
+  it { described_class.included_modules.should include Github::Connection }
+  it { described_class.included_modules.should include Github::Request }
+
+  context 'actions' do
+    it { described_class.new.should respond_to :api_methods_in }
+
+    it 'dynamically adds actions inspection to classes inheriting from api' do
+      repos.should respond_to :actions
+      repos.new.should respond_to :actions
+    end
+
+    it 'ensures output contains api methods' do
+      methods = [ 'method_a', 'method_b']
+      repos.stub(:instance_methods).and_return methods
+      output = capture(:stdout) { 
+        api.api_methods_in(repos)
+      }
+      output.should =~ /.*method_a.*/
+      output.should =~ /.*method_b.*/
+    end
   end
 
-  it "should stringify all the keys inside nested hash" do
-    actual = api.send(:_normalize_params_keys, @params)
-    expected = { 'a' => { 'b'=> { 'c' => 1 }, 'd' => [ 'a', { 'e'=> 2 }] } }
-    actual.should == expected
+  context '_normalize_params_keys' do
+    before do
+      @params = { 'a' => { :b => { 'c' => 1 }, 'd' => [ 'a', { :e => 2 }] } }
+    end
+
+    it "should stringify all the keys inside nested hash" do
+      actual = api.send(:_normalize_params_keys, @params)
+      expected = { 'a' => { 'b'=> { 'c' => 1 }, 'd' => [ 'a', { 'e'=> 2 }] } }
+      actual.should be_eql expected
+    end
   end
 
-  it "should filter param keys" do
-    valid = ['a', 'b', 'e']
-    hash = {'a' => 1, 'b' => 3, 'c' => 2, 'd'=> 4, 'e' => 5 }
-    actual = api.send(:_filter_params_keys, valid, hash)
-    expected = {'a' => 1, 'b' => 3, 'e' => 5 }
-    actual.should == expected
+  context '_filter_params_key' do
+    it "should remove non valid param keys" do
+      valid = ['a', 'b', 'e']
+      hash = {'a' => 1, 'b' => 3, 'c' => 2, 'd'=> 4, 'e' => 5 }
+      actual = api.send(:_filter_params_keys, valid, hash)
+      expected = {'a' => 1, 'b' => 3, 'e' => 5 }
+      actual.should be_eql expected
+    end
   end
 
-end
+end # Github::API

data/spec/github/paged_request_spec.rb

@@ -15,15 +15,15 @@ describe Github::PagedRequest do
     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_request path, {'page' => 3, 'per_page' => -1}
       Github::PagedRequest.page.should eq 3
-      Github::PagedRequest.per_page.should eq 25
+      Github::PagedRequest.per_page.should eq 30
     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_request path, {'per_page' => 33, 'page' => -1}
       Github::PagedRequest.page.should eq 1
       Github::PagedRequest.per_page.should eq 33
     end

data/spec/support/file_ops.rb

@@ -0,0 +1,14 @@
+require 'stringio'
+
+# Allow to capture stdout, stderr inside string for comparisons
+def capture(*streams)
+  streams.map! { |stream| stream.to_s }
+  begin
+    result = StringIO.new
+    streams.each { |stream| eval "$#{stream} = result" }
+    yield
+  ensure
+    streams.each { |stream| eval("$#{stream} = #{stream.upcase}")}
+  end
+  result.string
+end

metadata

@@ -2,7 +2,7 @@
 name: github_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-14 00:00:00 +00:00
+date: 2012-01-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -189,7 +189,7 @@ files:
 - features/step_definitions/github_api_steps.rb
 - features/support/env.rb
 - features/support/vcr.rb
-- lib/github_api/api/utils.rb
+- lib/github_api/api/actions.rb
 - lib/github_api/api.rb
 - lib/github_api/authorization.rb
 - lib/github_api/authorizations.rb
@@ -346,6 +346,7 @@ files:
 - spec/README.rdoc
 - spec/spec_helper.rb
 - spec/support/base.rb
+- spec/support/file_ops.rb
 - spec/support/github_api_shared_examples.rb
 - README.md
 - LICENSE.txt

data/lib/github_api/api/utils.rb

@@ -1,9 +0,0 @@
-module Github
-  class API
-    module Utils
-      
-      private
-
-    end
-  end
-end