github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/validations/format.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Github
+  module Validations
+    module Format
+
+      # Ensures that value for a given key is of the correct form whether
+      # matching regular expression or set of predefined values.
+      #
+      def _validate_params_values(permitted, params)
+        params.each do |k, v|
+          next unless permitted.keys.include?(k)
+          if permitted[k].is_a?(Array) && !permitted[k].include?(params[k])
+            raise ArgumentError, "Wrong value for #{k}, allowed: #{permitted[k].join(', ')}"
+          elsif permitted[k].is_a?(Regexp) && !(permitted[k] =~ params[k])
+            raise ArgumentError, "String does not match the parameter value."
+          end
+        end
+      end
+
+    end # Format
+  end # Validations
+end # Github

data/lib/github_api/validations/presence.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Github
+  module Validations
+    module Presence
+
+      # Ensures that esential arguments are present before request is made
+      #
+      def _validate_presence_of(*params)
+        params.each do |param|
+          raise ArgumentError, "parameter cannot be nil" if param.nil?
+        end
+      end
+
+
+      # Check if user or repository parameters are passed
+      #
+      def _validate_user_repo_params(user_name, repo_name)
+        raise ArgumentError, "[user] parameter cannot be nil" if user_name.nil?
+        raise ArgumentError, "[repo] parameter cannot be nil" if repo_name.nil?
+      end
+
+    end # Presence
+  end # Validations
+end # Github

data/lib/github_api/validations/required.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Github
+  module Validations
+    module Required
+
+      # Ensures that esential input parameters are present before request is made.
+      #
+      def _validate_inputs(required, provided)
+        result = required.all? do |key|
+          provided.has_deep_key? key
+        end
+        if !result
+          raise Github::Error::RequiredParams.new(provided, required)
+        end
+        result
+      end
+
+    end # Required
+  end # Validations
+end # Github

data/lib/github_api/validations/token.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Github
+  module Validations
+    module Token
+
+      TOKEN_REQUIRED = [
+        'get /user',
+        'get /user/emails',
+        'get /user/followers',
+        'get /user/following',
+        'get /user/keys',
+        'get /user/repos',
+        'patch /user',
+        'post /user/emails',
+        'post /user/keys',
+        'post /user/repos'
+      ]
+
+      TOKEN_REQUIRED_REGEXP = [
+        /repos\/.*\/.*\/comments/,
+      ]
+
+      # Ensures that required authentication token is present before
+      # request is sent.
+      #
+      def validates_token_for(method, path)
+        return true unless TOKEN_REQUIRED.grep("#{method} #{path}").empty?
+
+        token_required = false
+        TOKEN_REQUIRED_REGEXP.each do |regex|
+          if "#{method} #{path}" =~ regex
+            token_required = true
+          end
+        end
+        return token_required
+      end
+
+    end # Token
+  end # Validations
+end # Github

data/lib/github_api/version.rb

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

data/spec/fixtures/repos/commit_comparison.json

@@ -0,0 +1,112 @@
+{
+  "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic",
+  "html_url": "https://github.com/octocat/Hello-World/compare/master...topic",
+  "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17",
+  "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff",
+  "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch",
+  "base_commit": {
+    "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "commit": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "author": {
+        "name": "Monalisa Octocat",
+        "email": "support@github.com",
+        "date": "2011-04-14T16:00:49Z"
+      },
+      "committer": {
+        "name": "Monalisa Octocat",
+        "email": "support@github.com",
+        "date": "2011-04-14T16:00:49Z"
+      },
+      "message": "Fix all the bugs",
+      "tree": {
+        "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+      }
+    },
+    "author": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "committer": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "parents": [
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+      }
+    ]
+  },
+  "status": "behind",
+  "ahead_by": 1,
+  "behind_by": 2,
+  "total_commits": 1,
+  "commits": [
+    {
+      "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "commit": {
+        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "author": {
+          "name": "Monalisa Octocat",
+          "email": "support@github.com",
+          "date": "2011-04-14T16:00:49Z"
+        },
+        "committer": {
+          "name": "Monalisa Octocat",
+          "email": "support@github.com",
+          "date": "2011-04-14T16:00:49Z"
+        },
+        "message": "Fix all the bugs",
+        "tree": {
+          "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+          "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+        }
+      },
+      "author": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "committer": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "parents": [
+        {
+          "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+          "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+        }
+      ]
+    }
+  ],
+  "files": [
+    {
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "filename": "file1.txt",
+      "status": "added",
+      "additions": 103,
+      "deletions": 21,
+      "changes": 124,
+      "blob_url": "https://github.com/octocate/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+      "raw_url": "https://github.com/octocate/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+      "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
+    }
+ ]
+}

data/spec/github/api_factory_spec.rb

@@ -2,7 +2,8 @@
 
 require 'spec_helper'
 
-describe Github::ApiFactory, :type => :base do
+describe Github::ApiFactory do
+
   context '#new' do
     it 'throws error if klass type is ommitted' do
       expect { described_class.new nil }.to raise_error(ArgumentError)
@@ -12,4 +13,19 @@ describe Github::ApiFactory, :type => :base do
       described_class.new('Repos').should be_a Github::Repos
     end
   end
+
+  context '#create_instance' do
+    it 'sets api client' do
+      instance = Github::Issues::Labels.new
+      Github.should_receive(:api_client=).twice().and_return instance
+      described_class.create_instance('Issues::Labels', {})
+    end
+  end
+
+  context '#convert_to_constant' do
+    it 'knows how to convert nested classes' do
+      described_class.convert_to_constant('Issues::Labels').
+        should == Github::Issues::Labels
+    end
+  end
 end # Github::ApiFactory

data/spec/github/authorizations_spec.rb

@@ -15,6 +15,8 @@ describe Github::Authorizations do
   end
 
   describe "authorizations" do
+    it { github.authorizations.should respond_to :all }
+
     context "resource found" do
       before do
         stub_get("/authorizations", "https://#{basic_auth}@api.github.com").
@@ -24,33 +26,33 @@ describe Github::Authorizations do
 
       it "should fail to get resource without basic authentication" do
         reset_authentication_for github
-        expect { github.oauth.authorizations }.to raise_error(ArgumentError)
+        expect { github.oauth.list }.to raise_error(ArgumentError)
       end
 
       it "should get the resources" do
-        github.oauth.authorizations
+        github.oauth.list
         a_get("/authorizations", "https://#{basic_auth}@api.github.com").should have_been_made
       end
 
       it "should return array of resources" do
-        authorizations = github.oauth.authorizations
+        authorizations = github.oauth.list
         authorizations.should be_an Array
         authorizations.should have(1).items
       end
 
       it "should be a mash type" do
-        authorizations = github.oauth.authorizations
+        authorizations = github.oauth.list
         authorizations.first.should be_a Hashie::Mash
       end
 
       it "should get authorization information" do
-        authorizations = github.oauth.authorizations
+        authorizations = github.oauth.list
         authorizations.first.token.should == 'abc123'
       end
 
       it "should yield to a block" do
-        github.oauth.should_receive(:authorizations).and_yield('web')
-        github.oauth.authorizations { |param| 'web' }
+        github.oauth.should_receive(:list).and_yield('web')
+        github.oauth.list { |param| 'web' }
       end
     end
 
@@ -61,12 +63,12 @@ describe Github::Authorizations do
       end
 
       it "should return 404 with a message 'Not Found'" do
-        expect { github.oauth.authorizations }.to raise_error(Github::Error::NotFound)
+        expect { github.oauth.list }.to raise_error(Github::Error::NotFound)
       end
     end
   end # authorizations
 
-  describe "authorization" do
+  describe "#get" do
     let(:authorization_id) { 1 }
 
     context "resource found" do
@@ -76,22 +78,22 @@ describe Github::Authorizations do
       end
 
       it "should fail to get resource without authorization id" do
-        expect { github.oauth.authorization nil }.to raise_error(ArgumentError)
+        expect { github.oauth.get nil }.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
-        github.oauth.authorization authorization_id
+        github.oauth.get authorization_id
         a_get("/authorizations/#{authorization_id}", "https://#{basic_auth}@api.github.com").should have_been_made
       end
 
       it "should get authorization information" do
-        authorization = github.oauth.authorization authorization_id
+        authorization = github.oauth.get authorization_id
         authorization.id.should == authorization_id
         authorization.token.should == 'abc123'
       end
 
       it "should return mash" do
-        authorization = github.oauth.authorization authorization_id
+        authorization = github.oauth.get authorization_id
         authorization.should be_a Hashie::Mash
       end
     end
@@ -104,20 +106,20 @@ describe Github::Authorizations do
 
       it "should fail to retrive resource" do
         expect {
-          github.oauth.authorization authorization_id
+          github.oauth.get authorization_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # authorization
+  end # list
 
-  describe "create_authorization" do
+  describe "#create" do
     let(:inputs) { { :scopes => ['repo'] } }
 
     context "resouce created" do
 
       it "should fail to get resource without basic authentication" do
         reset_authentication_for github
-        expect { github.oauth.create_authorization }.to raise_error(ArgumentError)
+        expect { github.oauth.create }.to raise_error(ArgumentError)
       end
 
       before do
@@ -126,17 +128,17 @@ describe Github::Authorizations do
       end
 
       it "should create resource successfully" do
-        github.oauth.create_authorization inputs
+        github.oauth.create inputs
         a_post("/authorizations", "https://#{basic_auth}@api.github.com").with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        authorization = github.oauth.create_authorization inputs
+        authorization = github.oauth.create inputs
         authorization.should be_a Hashie::Mash
       end
 
       it "should get the authorization information" do
-        authorization = github.oauth.create_authorization inputs
+        authorization = github.oauth.create inputs
         authorization.token.should == 'abc123'
       end
     end
@@ -150,13 +152,13 @@ describe Github::Authorizations do
 
       it "should fail to retrieve resource" do
         expect {
-          github.oauth.create_authorization inputs
+          github.oauth.create inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # create_authorization
+  end # create
 
-  describe "update_authorization" do
+  describe "#update" do
     let(:authorization_id) { 1 }
     let(:inputs) { { :add_scopes => ['repo'] } }
 
@@ -164,7 +166,7 @@ describe Github::Authorizations do
 
       it "should fail to get resource without basic authentication" do
         reset_authentication_for github
-        expect { github.oauth.update_authorization }.to raise_error(ArgumentError)
+        expect { github.oauth.update }.to raise_error(ArgumentError)
       end
 
       before do
@@ -173,17 +175,17 @@ describe Github::Authorizations do
       end
 
       it "should update resource successfully" do
-        github.oauth.update_authorization authorization_id, inputs
+        github.oauth.update authorization_id, inputs
         a_patch("/authorizations/#{authorization_id}", "https://#{basic_auth}@api.github.com").with(inputs).should have_been_made
       end
 
       it "should return the resource" do
-        authorization = github.oauth.update_authorization authorization_id, inputs
+        authorization = github.oauth.update authorization_id, inputs
         authorization.should be_a Hashie::Mash
       end
 
       it "should get the authorization information" do
-        authorization = github.oauth.update_authorization authorization_id, inputs
+        authorization = github.oauth.update authorization_id, inputs
         authorization.token.should == 'abc123'
       end
     end
@@ -197,13 +199,13 @@ describe Github::Authorizations do
 
       it "should fail to retrieve resource" do
         expect {
-          github.oauth.update_authorization authorization_id, inputs
+          github.oauth.update authorization_id, inputs
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # update_authorization
+  end # update
 
-  describe "delete_authorization" do
+  describe "#delete" do
     let(:authorization_id) { 1 }
     let(:inputs) { { :add_scopes => ['repo'] } }
 
@@ -211,7 +213,7 @@ describe Github::Authorizations do
 
       it "should fail to get resource without basic authentication" do
         reset_authentication_for github
-        expect { github.oauth.delete_authorization nil }.to raise_error(ArgumentError)
+        expect { github.oauth.delete nil }.to raise_error(ArgumentError)
       end
 
       before do
@@ -220,7 +222,7 @@ describe Github::Authorizations do
       end
 
       it "should delete resource successfully" do
-        github.oauth.delete_authorization authorization_id
+        github.oauth.delete authorization_id
         a_delete("/authorizations/#{authorization_id}", "https://#{basic_auth}@api.github.com").should have_been_made
       end
     end
@@ -234,10 +236,10 @@ describe Github::Authorizations do
 
       it "should fail to retrieve resource" do
         expect {
-          github.oauth.delete_authorization authorization_id
+          github.oauth.delete authorization_id
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # delete_authorization
+  end # delete
 
 end # Github::Authorizations