github_api 0.4.6 → 0.4.7

data/features/support/vcr.rb

@@ -1,7 +1,7 @@
 require 'vcr'
 
-VCR.config do |conf|
-  conf.stub_with :webmock
+VCR.configure do |conf|
+  conf.hook_into :webmock
   conf.cassette_library_dir = 'features/cassettes'
   conf.default_cassette_options = { :record => :new_episodes }
   conf.filter_sensitive_data('<***>') { ''}

data/lib/github_api/authorization.rb

@@ -17,7 +17,7 @@ module Github
     # Strategy token
     def auth_code
       _verify_client
-      @client.auth_code
+      client.auth_code
     end
 
     # Sends authorization request to GitHub.
@@ -33,13 +33,13 @@ module Github
     #
     def authorize_url(params = {})
       _verify_client
-      @client.auth_code.authorize_url(params)
+      client.auth_code.authorize_url(params)
     end
 
     # Makes request to token endpoint and retrieves access token value
     def get_token(authorization_code, params = {})
       _verify_client
-      @client.auth_code.get_token(authorization_code, params)
+      client.auth_code.get_token(authorization_code, params)
     end
 
     # Check whether authentication credentials are present

data/lib/github_api/error.rb

@@ -26,6 +26,9 @@ end # Github
   service_unavailable
   internal_server_error
   unprocessable_entity
+  client_error
+  invalid_options
+  required_params
 ].each do |error|
   require "github_api/error/#{error}"
 end

data/lib/github_api/error/client_error.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 404
+  module Error
+    class ClientError < GithubError
+      attr_reader :problem, :summary, :resolution
+
+      def initialize(message)
+        super(message)
+      end
+
+      def generate_message(attributes)
+        "\nProblem:\n #{attributes[:problem]}"+
+        "\nSummary:\n #{attributes[:summary]}"+
+        "\nResolution:\n #{attributes[:resolution]}"
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/invalid_options.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class InvalidOptions < ClientError
+      def initialize(invalid, valid)
+        super(
+          generate_message(
+            :problem => "Invalid option #{invalid.keys.join(', ')} provided for this request.", 
+            :summary => "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            :resolution => "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/required_params.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class RequiredParams < ClientError
+      def initialize(provided, required)
+        super(
+          generate_message(
+            :problem => "Missing required parameters: #{provided.keys.join(', ')} provided for this request.",
+            :summary => "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            :resolution => "Required parameters are: #{required.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/service_error.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Github #:nodoc
-  # Raised when Github returns the HTTP status code 404
+  # Raised when Github returns any of the HTTP status codes
   module Error
     class ServiceError < GithubError
       attr_accessor :http_headers

data/lib/github_api/error/validations.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when passed parameters are missing or contain wrong values.
+  module Error
+    class Validations < ClientError
+      def initialize(errors)
+        super(
+          generate_message(
+            :problem => '',
+            :summary => '',
+            :resolution => ''
+          )
+        )
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/gists.rb

@@ -105,11 +105,7 @@ module Github
     #
     def create_gist(params={})
       _normalize_params_keys(params)
-
-      unless _validate_inputs(REQUIRED_GIST_INPUTS, params)
-        raise ArgumentError,
-          "Required parameters are: #{REQUIRED_GIST_INPUTS.join(', ')}"
-      end
+      _validate_inputs(REQUIRED_GIST_INPUTS, params)
 
       post("/gists", params)
     end

data/lib/github_api/gists/comments.rb

@@ -58,10 +58,7 @@ module Github
         _normalize_params_keys(params)
         # _merge_mime_type(:gist_comment, params)
         _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
-
-        unless _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
-          raise ArgumentError, "Required inputs are: :body"
-        end
+        _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
 
         post("/gists/#{gist_id}/comments", params)
       end
@@ -78,10 +75,7 @@ module Github
         _validate_presence_of(comment_id)
         # _merge_mime_type(:gist_comment, params)
         _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
-
-        unless _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
-          raise ArgumentError, "Required inputs are: :body"
-        end
+        _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
 
         patch("/gists/comments/#{comment_id}", params)
       end

data/lib/github_api/git_data/blobs.rb

@@ -42,8 +42,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_BLOB_PARAM_NAMES, params)
-
-        raise ArgumentError, "Required params are: #{VALID_BLOB_PARAM_NAMES.join(', ')}" unless _validate_inputs(VALID_BLOB_PARAM_NAMES, params)
+        _validate_inputs(VALID_BLOB_PARAM_NAMES, params)
 
         post("/repos/#{user}/#{repo}/git/blobs", params)
       end

data/lib/github_api/git_data/commits.rb

@@ -74,8 +74,7 @@ module Github
         _validate_user_repo_params(user, repo) unless user? && repo?
         _normalize_params_keys(params)
         _filter_params_keys(VALID_COMMIT_PARAM_NAMES, params)
-
-        raise ArgumentError, "Required params are: message, tree, parents" unless _validate_inputs(REQUIRED_COMMIT_PARAMS, params)
+        _validate_inputs(REQUIRED_COMMIT_PARAMS, params)
 
         post("/repos/#{user}/#{repo}/git/commits", params)
       end

data/lib/github_api/git_data/references.rb

@@ -83,8 +83,7 @@ module Github
         _normalize_params_keys params
         _filter_params_keys VALID_REF_PARAM_NAMES, params
         _validate_reference params['ref']
-
-        raise ArgumentError, "Required params are: ref, sha" unless _validate_inputs(%w[ ref sha ], params)
+        _validate_inputs(%w[ ref sha ], params)
 
         post("/repos/#{user}/#{repo}/git/refs", params)
       end
@@ -109,8 +108,7 @@ module Github
         _validate_reference ref
         _normalize_params_keys(params)
         _filter_params_keys(VALID_REF_PARAM_NAMES, params)
-
-        raise ArgumentError, "Required params are: sha" unless _validate_inputs(%w[ sha ], params)
+        _validate_inputs(%w[ sha ], params)
 
         patch("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
       end

data/lib/github_api/git_data/trees.rb

@@ -86,7 +86,7 @@ module Github
         _validate_user_repo_params(user, repo) unless user? && repo?
         _normalize_params_keys(params)
 
-        raise ArgumentError, "Required param: 'tree'" unless _validate_inputs(%w[ tree ], params)
+        _validate_inputs(%w[ tree ], params)
 
         _filter_params_keys(VALID_TREE_PARAM_NAMES, params['tree'])
         _validate_params_values(VALID_TREE_PARAM_VALUES, params['tree'])

data/lib/github_api/issues.rb

@@ -171,8 +171,7 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:issue, params)
       _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
-
-      raise ArgumentError, "Required params are: :title" unless _validate_inputs(%w[ title ], params)
+      _validate_inputs(%w[ title ], params)
 
       post("/repos/#{user}/#{repo}/issues", params)
     end

data/lib/github_api/issues/comments.rb

@@ -70,7 +70,7 @@ module Github
         _normalize_params_keys(params)
         # _merge_mime_type(:issue_comment, params)
         _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
-        raise ArgumentError, "Required params are: :body" unless _validate_inputs(%w[ body ], params)
+        _validate_inputs(%w[ body ], params)
 
         post("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
       end
@@ -94,7 +94,7 @@ module Github
         _normalize_params_keys(params)
         # _merge_mime_type(:issue_comment, params)
         _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
-        raise ArgumentError, "Required params are: :body" unless _validate_inputs(%w[ body ], params)
+        _validate_inputs(%w[ body ], params)
 
         patch("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
       end

data/lib/github_api/issues/labels.rb

@@ -56,8 +56,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_LABEL_INPUTS, params)
-
-        raise ArgumentError, "Required params are: :name, :color" unless _validate_inputs(VALID_LABEL_INPUTS, params)
+        _validate_inputs(VALID_LABEL_INPUTS, params)
 
         post("/repos/#{user}/#{repo}/labels", params)
       end
@@ -79,8 +78,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_LABEL_INPUTS, params)
-
-        raise ArgumentError, "Required params are: :name, :color" unless _validate_inputs(VALID_LABEL_INPUTS, params)
+        _validate_inputs(VALID_LABEL_INPUTS, params)
 
         patch("/repos/#{user}/#{repo}/labels/#{label_id}", params)
       end

data/lib/github_api/issues/milestones.rb

@@ -85,8 +85,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_MILESTONE_INPUTS, params)
-
-        raise ArgumentError, "Required params are: :title" unless _validate_inputs(%w[ title ], params)
+        _validate_inputs(%w[ title ], params)
 
         post("/repos/#{user}/#{repo}/milestones", params)
       end
@@ -114,8 +113,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_MILESTONE_INPUTS, params)
-
-        raise ArgumentError, "Required params are: :title" unless _validate_inputs(%w[ title ], params)
+        _validate_inputs(%w[ title ], params)
 
         patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
       end

data/lib/github_api/orgs/teams.rb

@@ -67,8 +67,7 @@ module Github
         _normalize_params_keys(params)
         _filter_params_keys(VALID_TEAM_PARAM_NAMES, params)
         _validate_params_values(VALID_TEAM_PARAM_VALUES, params)
-
-        raise ArgumentError, "Required params are: :name" unless _validate_inputs(%w[ name ], params)
+        _validate_inputs(%w[ name ], params)
 
         post("/orgs/#{org_name}/teams", params)
       end
@@ -92,10 +91,10 @@ module Github
       def edit_team(team_name, params={})
         _validate_presence_of team_name
         _normalize_params_keys(params)
+
         _filter_params_keys(VALID_TEAM_PARAM_NAMES, params)
         _validate_params_values(VALID_TEAM_PARAM_VALUES, params)
-
-        raise ArgumentError, "Required params are: :name" unless _validate_inputs(%w[ name ], params)
+        _validate_inputs(%w[ name ], params)
 
         patch("/teams/#{team_name}", params)
       end

data/lib/github_api/repos.rb

@@ -59,7 +59,7 @@ module Github
     #   @repos = Github::Repos.new
     #   @repos.branches 'user-name', 'repo-name'
     #
-    def branches(user_name=nil, repo_name=nil, params={})
+    def branches(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless (user? && repo?)
       _normalize_params_keys(params)
@@ -103,7 +103,11 @@ module Github
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REPO_OPTIONS + %w[ org ], params)
 
-      raise ArgumentError, "Required params are: :name" unless _validate_inputs(%w[ name ], params)
+#       if !_validate_inputs(%w[ name ], params)
+#         raise ArgumentError, "Required params are: :name"
+#       end
+
+      _validate_inputs(%w[ name ], params)
 
       # Requires authenticated user
       if (org = params.delete("org"))
@@ -161,7 +165,9 @@ module Github
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REPO_OPTIONS, params)
 
-      raise ArgumentError, "Required params are: #{%w[ :name ] }" unless _validate_inputs(%w[ name ], params)
+      unless _validate_inputs(%w[ name ], params)
+        raise ArgumentError, "Required params are: #{%w[ :name ] }"
+      end
 
       patch("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
     end

data/lib/github_api/repos/commits.rb

@@ -38,7 +38,7 @@ module Github
         _normalize_params_keys(params)
         _filter_params_keys(REQUIRED_COMMENT_PARAMS, params)
 
-        raise ArgumentError, "Expected following inputs to the method: #{REQUIRED_COMMENT_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_COMMENT_PARAMS, params)
+        _validate_inputs(REQUIRED_COMMENT_PARAMS, params)
 
         post("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
       end
@@ -170,7 +170,7 @@ module Github
         _validate_presence_of comment_id
 
         _normalize_params_keys(params)
-        raise ArgumentError, "expected following inputs to the method: 'body'" unless _validate_inputs(["body"], params)
+        _validate_inputs(%w[ body ], params)
 
         patch("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end

data/lib/github_api/repos/downloads.rb

@@ -100,8 +100,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_DOWNLOAD_PARAM_NAMES, params)
-
-        raise ArgumentError, "Required parameters are: #{REQUIRED_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_PARAMS, params)
+        _validate_inputs(REQUIRED_PARAMS, params)
 
         post("/repos/#{user}/#{repo}/downloads", params)
       end

data/lib/github_api/repos/hooks.rb

@@ -97,10 +97,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_HOOK_PARAM_NAMES, params, :recursive => false)
-
-        unless _validate_inputs(REQUIRED_PARAMS, params)
-          raise ArgumentError, "Required parameters are: name, config"
-        end
+        _validate_inputs(REQUIRED_PARAMS, params)
 
         post("/repos/#{user}/#{repo}/hooks", params)
       end
@@ -133,10 +130,7 @@ module Github
 
         _normalize_params_keys(params)
         _filter_params_keys(VALID_HOOK_PARAM_NAMES, params, :recursive => false)
-
-        unless _validate_inputs(REQUIRED_PARAMS, params)
-          raise ArgumentError, "Required parameters are: name, config"
-        end
+        _validate_inputs(REQUIRED_PARAMS, params)
 
         patch("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
       end

data/lib/github_api/repos/keys.rb

@@ -50,13 +50,12 @@ module Github
       #    "title" => "octocat@octomac",
       #    "key" =>  "ssh-rsa AAA..."
       #
-      def create_key(user_name=nil, repo_name=nil, params={})
+      def create_key(user_name, repo_name, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _normalize_params_keys(params)
         _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
-
-        raise ArgumentError, "Required params are: #{VALID_KEY_PARAM_NAMES.join(', ')}" unless _validate_inputs(VALID_KEY_PARAM_NAMES, params)
+        _validate_inputs(VALID_KEY_PARAM_NAMES, params)
 
         post("/repos/#{user}/#{repo}/keys", params)
       end

data/lib/github_api/validation.rb

@@ -12,9 +12,13 @@ module Github
     # Ensures that esential input parameters are present before request is made
     #
     def _validate_inputs(required, provided)
-      required.all? do |key|
+      result = required.all? do |key|
         provided.has_deep_key? key
       end
+      if !result
+        raise Github::Error::RequiredParams.new(provided, required)
+      end
+      result
     end
 
     # Ensures that esential arguments are present before request is made