github_api 0.9.0 → 0.9.1

data/lib/github_api/users/keys.rb

@@ -8,13 +8,13 @@ module Github
     # List public keys for the authenticated user
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.keys.list
     #  github.users.keys.list { |key| ... }
     #
-    def list(params={})
-      normalize! params
-      response = get_request("/user/keys", params)
+    def list(*args)
+      arguments(args)
+      response = get_request("/user/keys", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -23,13 +23,12 @@ module Github
     # Get a single pulic key for the authenticated user
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.keys.get 'key-id'
     #
-    def get(key_id, params={})
-      assert_presence_of key_id
-      normalize! params
-      get_request("/user/keys/#{key_id}", params)
+    def get(*args)
+      arguments(args, :required => [:key_id])
+      get_request("/user/keys/#{key_id}", arguments.params)
     end
     alias :find :get
 
@@ -40,14 +39,14 @@ module Github
     # * <tt>:key</tt> - Required string. sha key
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.users.keys.create "title" => "octocat@octomac",
-    #    "key" => "ssh-rsa AAA..."
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.create "title": "octocat@octomac", "key": "ssh-rsa AAA..."
     #
-    def create(params={})
-      normalize! params
-      filter! VALID_KEY_PARAM_NAMES, params
-      post_request("/user/keys", params)
+    def create(*args)
+      arguments(args) do
+        sift VALID_KEY_PARAM_NAMES
+      end
+      post_request("/user/keys", arguments.params)
     end
 
     # Update a public key for the authenticated user
@@ -57,27 +56,26 @@ module Github
     # * <tt>:key</tt> - Required string. sha key
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.users.keys.update 'key-id', "title" => "octocat@octomac",
-    #    "key" => "ssh-rsa AAA..."
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.update 'key-id', "title": "octocat@octomac",
+    #    "key": "ssh-rsa AAA..."
     #
-    def update(key_id, params={})
-      assert_presence_of key_id
-      normalize! params
-      filter! VALID_KEY_PARAM_NAMES, params
-      patch_request("/user/keys/#{key_id}", params)
+    def update(*args)
+      arguments(args, :required => [:key_id]) do
+        sift VALID_KEY_PARAM_NAMES
+      end
+      patch_request("/user/keys/#{key_id}", arguments.params)
     end
 
     # Delete a public key for the authenticated user
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.keys.delete 'key-id'
     #
-    def delete(key_id, params={})
-      assert_presence_of key_id
-      normalize! params
-      delete_request("/user/keys/#{key_id}", params)
+    def delete(*args)
+      arguments(args, :required => [:key_id])
+      delete_request("/user/keys/#{key_id}", arguments.params)
     end
 
   end # Users::Keys

data/lib/github_api/version.rb

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

data/spec/github/activity/events/org_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Github::Activity::Events, '#org' do
+describe Github::Activity::Events, '#organization' do
   let(:org) { 'github' }
   let(:request_path) { "/orgs/#{org}/events" }
   let(:body) { fixture('events/events.json') }
@@ -19,11 +19,11 @@ describe Github::Activity::Events, '#org' do
     it { should respond_to :organization }
 
     it "should fail to get resource without orgname" do
-      expect { subject.org nil }.to raise_error(ArgumentError)
+      expect { subject.organization }.to raise_error(ArgumentError)
     end
 
     it "should get the resources" do
-      subject.org org
+      subject.organization org
       a_get(request_path).should have_been_made
     end
 
@@ -32,19 +32,19 @@ describe Github::Activity::Events, '#org' do
     end
 
     it "should get event information" do
-      events = subject.org org
+      events = subject.organization org
       events.first.type.should == 'Event'
     end
 
     it "should yield to a block" do
       yielded = []
-      result = subject.org(org) { |obj| yielded << obj }
+      result = subject.organization(org) { |obj| yielded << obj }
       yielded.should == result
     end
   end
 
   it_should_behave_like 'request failure' do
-    let(:requestable) { subject.org org }
+    let(:requestable) { subject.organization org }
   end
 
 end # org

data/spec/github/activity/events/performed_spec.rb

@@ -18,7 +18,7 @@ describe Github::Activity::Events, '#performed' do
   context "resource found" do
 
     it "should fail to get resource without username" do
-      expect { subject.performed nil }.to raise_error(ArgumentError)
+      expect { subject.performed }.to raise_error(ArgumentError)
     end
 
     it "should get the resources" do

data/spec/github/activity/events/received_spec.rb

@@ -18,7 +18,7 @@ describe Github::Activity::Events, '#received' do
   context "resource found" do
 
     it "should fail to get resource without username" do
-      expect { subject.received nil }.to raise_error(ArgumentError)
+      expect { subject.received }.to raise_error(ArgumentError)
     end
 
     it "should get the resources" do

data/spec/github/activity/events/user_org_spec.rb

@@ -19,8 +19,10 @@ describe Github::Activity::Events, '#user_org' do
   context "resource found" do
     it { should respond_to :user_organization }
 
+    it { expect { subject.user_org }.to raise_error(ArgumentError) }
+
     it "should fail to get resource without orgname" do
-      expect { subject.user_org user, nil }.to raise_error(ArgumentError)
+      expect { subject.user_org user }.to raise_error(ArgumentError)
     end
 
     it "should get the resources" do
@@ -45,7 +47,7 @@ describe Github::Activity::Events, '#user_org' do
   end
 
   it_should_behave_like 'request failure' do
-    let(:requestable) { subject.user_org user, org }
+    let(:requestable) { subject.user_org(user, org) }
   end
 
 end # user_org

data/spec/github/activity/notifications/create_spec.rb

@@ -26,7 +26,7 @@ describe Github::Activity::Notifications, '#create' do
     let(:status) { 200 }
 
     it 'asserts thread id presence' do
-      expect { subject.create nil }.to raise_error(ArgumentError)
+      expect { subject.create }.to raise_error(ArgumentError)
     end
 
     it 'should create resource' do

data/spec/github/activity/notifications/delete_spec.rb

@@ -26,7 +26,7 @@ describe Github::Activity::Notifications, '#delete' do
   end
 
   it "should fail to delete resource without 'user' parameter" do
-    expect { subject.delete nil }.to raise_error(ArgumentError)
+    expect { subject.delete }.to raise_error(ArgumentError)
   end
 
   context 'failed to delete' do

data/spec/github/activity/notifications/get_spec.rb

@@ -20,7 +20,7 @@ describe Github::Activity::Notifications, '#get' do
     it { should respond_to(:find) }
 
     it "should raise error when no thread-id parameter" do
-      expect { subject.get nil }.to raise_error(ArgumentError)
+      expect { subject.get }.to raise_error(ArgumentError)
     end
 
     it "should find resources" do

data/spec/github/activity/notifications/subscribed_spec.rb

@@ -20,7 +20,7 @@ describe Github::Activity::Notifications, '#subscribed?' do
     let(:status) { 200 }
 
     it 'asserts thread id presence' do
-      expect { subject.subscribed? nil }.to raise_error(ArgumentError)
+      expect { subject.subscribed? }.to raise_error(ArgumentError)
     end
 
     it 'gets the resource' do

data/spec/github/activity/starring/list_spec.rb

@@ -20,6 +20,8 @@ describe Github::Activity::Starring, '#list' do
 
     it { should respond_to :all }
 
+    it { expect { subject.list user }.to raise_error(ArgumentError) }
+
     it "should fail to get resource without username" do
       expect { subject.list }.to raise_error(ArgumentError)
     end

data/spec/github/activity/starring/starring_spec.rb

@@ -32,7 +32,7 @@ describe Github::Activity::Starring, '#list' do
 
   context "without username and reponame passed" do
     it "should fail validation " do
-      expect { subject.starring? nil, nil }.to raise_error(ArgumentError)
+      expect { subject.starring? user }.to raise_error(ArgumentError)
     end
   end
 end # starring?

data/spec/github/activity/watching/list_spec.rb

@@ -16,6 +16,8 @@ describe Github::Activity::Watching, '#list' do
       to_return(:body => body, :status => status, :headers => {})
   }
 
+  it { expect { subject.list user }.to raise_error(ArgumentError) }
+
   it "should fail to get resource without username" do
     expect { subject.list }.to raise_error(ArgumentError)
   end

data/spec/github/activity/watching/watching_spec.rb

@@ -33,9 +33,7 @@ describe Github::Activity::Watching, '#list' do
 
   context "without username and reponame passed" do
     it "should fail validation " do
-      expect {
-        subject.watching?(nil, nil)
-      }.to raise_error(ArgumentError)
+      expect { subject.watching? user, nil }.to raise_error(ArgumentError)
     end
   end
 end # watching?

data/spec/github/api/set_spec.rb

@@ -10,10 +10,24 @@ describe Github::API, '#set' do
     expect { subject.set :option }.to raise_error(ArgumentError)
   end
 
-  it 'accepts more than one option' do
-    subject.set :user => 'user-name', :repo => 'repo-name'
-    subject.user.should == 'user-name'
-    subject.repo.should == 'repo-name'
+  context 'accpets more than one option' do
+    before { subject.set :user => 'user-name', :repo => 'repo-name' }
+
+    it 'sets user' do
+      subject.user.should == 'user-name'
+    end
+
+    it 'sets repo' do
+      subject.repo.should == 'repo-name'
+    end
+  end
+
+  context 'defines accessors' do
+    before { subject.set :branch, 'arguments' }
+
+    it { should respond_to :branch }
+
+    it { should respond_to 'branch=' }
   end
 
 end

data/spec/github/api/with_spec.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Github::API, '#with' do
+  let(:user) { 'peter-murach' }
+
+  after { reset_authentication_for subject }
+
+  context 'with hash' do
+    it 'supports list of options' do
+      subject.with(:user => user, :repo => 'github')
+      subject.user.should == user
+    end
+  end
+
+  context 'with string' do
+    it 'support forward slash delimiter options' do
+      subject.with('peter-murach/github')
+      subject.user.should == user
+    end
+
+    it 'fails without slash delimiter' do
+      expect { subject.with('peter-murach') }.to raise_error(ArgumentError)
+    end
+  end
+
+end

data/spec/github/api_spec.rb

@@ -1,8 +1,7 @@
 require 'spec_helper'
 
 describe Github::API do
-  let(:api) { Github::API.new }
-  let(:repos) { Github::Repos }
+  subject { described_class.new(options) }
 
   it { described_class.included_modules.should include Github::Authorization }
   it { described_class.included_modules.should include Github::MimeType }
@@ -10,7 +9,10 @@ describe Github::API do
   it { described_class.included_modules.should include Github::Request }
 
   context 'actions' do
-    it { described_class.new.should respond_to :api_methods_in }
+    let(:options) { { } }
+    let(:repos) { Github::Repos }
+
+    it { should respond_to :api_methods_in }
 
     it 'dynamically adds actions inspection to classes inheriting from api' do
       repos.should respond_to :actions
@@ -21,44 +23,20 @@ describe Github::API do
       methods = [ 'method_a', 'method_b']
       repos.stub(:instance_methods).and_return methods
       output = capture(:stdout) { 
-        api.api_methods_in(repos)
+        subject.api_methods_in(repos)
       }
       output.should =~ /.*method_a.*/
       output.should =~ /.*method_b.*/
     end
   end
 
-  context '_process_basic_auth' do
-    let(:github) { Github.new :basic_auth => 'login:password' }
-
-    after { reset_authentication_for github }
-
-    it 'should parse authentication params' do
-      github.login.should eq 'login'
-      github.password.should eq 'password'
-    end
-  end
+  context 'process_basic_auth' do
+    let(:options) { { :basic_auth => 'login:password' } }
 
-  context 'normalize!' do
-    before do
-      @params = { 'a' => { :b => { 'c' => 1 }, 'd' => [ 'a', { :e => 2 }] } }
-    end
+    its(:login) { should eq 'login' }
 
-    it "should stringify all the keys inside nested hash" do
-      actual = api.normalize! @params
-      expected = { 'a' => { 'b'=> { 'c' => 1 }, 'd' => [ 'a', { 'e'=> 2 }] } }
-      actual.should be_eql expected
-    end
-  end
+    its(:password) { should eq 'password' }
 
-  context 'filter!' 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.filter! valid, hash
-      expected = {'a' => 1, 'b' => 3, 'e' => 5 }
-      actual.should be_eql expected
-    end
+    its(:basic_auth) { should eq 'login:password' }
   end
-
 end # Github::API

data/spec/github/arguments/parse_spec.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Arguments, '#parse' do
+  let(:api)    { Github::Repos.new }
+  let(:object) { described_class.new api, 'required' => required }
+  let(:arguments) { ['peter-murach', 'github', params] }
+  let(:params) { { :page => 23 } }
+  let(:required) { [:user, :repo] }
+
+  subject { object.parse *arguments }
+
+  after { api.user =nil; api.repo = nil }
+
+  context 'with required arguments' do
+
+    it { should == object }
+
+    its(:params) { should == params }
+
+    context 'sets parameters' do
+      it { subject.api.user.should == 'peter-murach' }
+
+      it { subject.api.repo.should == 'github' }
+    end
+
+    context 'with no arguments search parameters hash' do
+      let(:arguments) { nil }
+
+      it 'asserts lack of presence of hash parameters' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with nil argument' do
+      let(:arguments) { [nil, 'github', params] }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(ArgumentError, /parameter/)
+      end
+    end
+
+    context 'with hash arguments' do
+      let(:arguments) { [{:user => 'peter-murach', :repo => 'github'}.merge(params)]}
+
+      it 'sets parameters' do
+        subject.api.user.should == 'peter-murach'
+      end
+    end
+  end
+
+  context 'with less than required arguments' do
+    let(:required) { [:user, :repo] }
+    let(:arguments) { ['peter-murach', params] }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error(ArgumentError, /wrong number/)
+    end
+  end
+
+  context 'without required arguments' do
+    let(:required) { [] }
+    let(:arguments) { [params] }
+
+    its(:params) { should == params }
+  end
+end