github_api 0.5.4 → 0.6.0

data/features/search.feature

@@ -0,0 +1,48 @@
+Feature: Search API
+
+  Background:
+    Given I have "Github::Search" instance
+
+  Scenario: Issues
+
+    Given I want issues resource
+      And I pass the following request options:
+        | owner        | repo   | state  | keyword |
+        | peter-murach | github | closed | api     |
+    When I make request within a cassette named "search/issues"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Repositories
+
+    Given I want repositories resource
+      And I pass the following request options:
+        | keyword |
+        | rails   |
+    When I make request within a cassette named "search/repos"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Users
+
+    Given I want users resource
+      And I pass the following request options:
+        | keyword |
+        | wycats  |
+    When I make request within a cassette named "search/users"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Email
+
+    Given I want email resource
+      And I pass the following request options:
+        | email            |
+        | wycats@gmail.com |
+    When I make request within a cassette named "search/email"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty

data/features/users.feature

@@ -0,0 +1,23 @@
+Feature: Users API
+
+  Background:
+    Given I have "Github::Users" instance
+
+  Scenario: Get authenticated user
+
+    Given I want to get resource
+    When I make request within a cassette named "users/get/oauth"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Get unauthenticated user
+
+    Given I want to get resource
+    And I pass the following request options:
+      | user         |
+      | peter-murach |
+    When I make request within a cassette named "users/get/user"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty

data/lib/github_api.rb

@@ -74,6 +74,7 @@ module Github
     :PullRequests => 'pull_requests',
     :Users        => 'users',
     :Events       => 'events',
+    :Search       => 'search',
     :CoreExt      => 'core_ext',
     :MimeType     => 'mime_type',
     :Authorization => 'authorization',

data/lib/github_api/api.rb

@@ -12,8 +12,6 @@ require 'github_api/api/actions'
 require 'github_api/api_factory'
 
 module Github
-
-  # @private
   class API
     include Authorization
     include MimeType
@@ -23,7 +21,6 @@ module Github
     include Validations
     include Filter
 
-
     attr_reader *Configuration::VALID_OPTIONS_KEYS
     attr_accessor *VALID_API_KEYS
 
@@ -116,17 +113,5 @@ module Github
 #       params['mime_type'] = params['mime_type'] || :raw
     end
 
-    # TODO add to core extensions
-    def _extract_parameters(array)
-      if array.last.is_a?(Hash) && array.last.instance_of?(Hash)
-        array.pop
-      else
-        {}
-      end
-    end
-
-    def _token_required
-    end
-
   end # API
 end # Github

data/lib/github_api/client.rb

@@ -45,6 +45,10 @@ module Github
       @events ||= ApiFactory.new 'Events', options
     end
 
+    def search(options = {})
+      @search ||= ApiFactory.new 'Search', options
+    end
+
     # An API for users to manage their own tokens. You can only access your own
     # tokens, and only through Basic Authentication.
     def oauth(options = {})

data/lib/github_api/constants.rb

@@ -11,12 +11,16 @@ module Github
 
     CONTENT_LENGTH = 'content-length'.freeze
 
+    CACHE_CONTROL = 'cache-control'.freeze
+
     ETAG = 'ETag'.freeze
 
     SERVER = 'Server'.freeze
 
     DATE = 'Date'.freeze
 
+    LOCATION = 'Location'.freeze
+
     # Link headers
     HEADER_LINK = "Link".freeze
 

data/lib/github_api/error.rb

@@ -29,6 +29,7 @@ end # Github
   client_error
   invalid_options
   required_params
+  unknown_value
 ].each do |error|
   require "github_api/error/#{error}"
 end

data/lib/github_api/error/unknown_value.rb

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

data/lib/github_api/filter.rb

@@ -32,6 +32,7 @@ module Github
     end
 
     # Removes any keys from nested hashes that don't match predefiend keys
+    # filter_valid_keys
     def _filter_params_keys(keys, params, options={:recursive => true})  # :nodoc:
       case params
       when Hash

data/lib/github_api/gists.rb

@@ -7,8 +7,6 @@ module Github
     autoload_all 'github_api/gists',
       :Comments => 'comments'
 
-    # include Github::Gists::Comments
-
     REQUIRED_GIST_INPUTS = %w[
       description
       public
@@ -63,9 +61,7 @@ module Github
     #  github.gists.starred
     #
     def starred(params={})
-      process_params do
-        normalize params
-      end
+      _normalize_params_keys(params)
 
       response = get_request("/gists/starred", params)
       return response unless block_given?
@@ -109,7 +105,7 @@ module Github
     #
     def create(params={})
       _normalize_params_keys(params)
-      _validate_inputs(REQUIRED_GIST_INPUTS, params)
+      assert_required_keys(REQUIRED_GIST_INPUTS, params)
 
       post_request("/gists", params)
     end

data/lib/github_api/gists/comments.rb

@@ -55,7 +55,7 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:gist_comment, params)
       _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
-      _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
+      assert_required_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
 
       post_request("/gists/#{gist_id}/comments", params)
     end
@@ -71,7 +71,7 @@ module Github
       _validate_presence_of(comment_id)
       # _merge_mime_type(:gist_comment, params)
       _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
-      _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
+      assert_required_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
 
       patch_request("/gists/comments/#{comment_id}", params)
     end

data/lib/github_api/git_data/blobs.rb

@@ -46,7 +46,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_BLOB_PARAM_NAMES, params)
-      _validate_inputs(VALID_BLOB_PARAM_NAMES, params)
+      assert_required_keys(VALID_BLOB_PARAM_NAMES, params)
 
       post_request("/repos/#{user}/#{repo}/git/blobs", params)
     end

data/lib/github_api/git_data/commits.rb

@@ -78,7 +78,7 @@ module Github
       _validate_user_repo_params(user, repo) unless user? && repo?
       _normalize_params_keys(params)
       _filter_params_keys(VALID_COMMIT_PARAM_NAMES, params)
-      _validate_inputs(REQUIRED_COMMIT_PARAMS, params)
+      assert_required_keys(REQUIRED_COMMIT_PARAMS, params)
 
       post_request("/repos/#{user}/#{repo}/git/commits", params)
     end

data/lib/github_api/git_data/references.rb

@@ -88,7 +88,7 @@ module Github
       _filter_params_keys VALID_REF_PARAM_NAMES, params
       _validate_presence_of params['ref']
       _validate_reference params['ref']
-      _validate_inputs(%w[ ref sha ], params)
+      assert_required_keys(%w[ ref sha ], params)
 
       post_request("/repos/#{user}/#{repo}/git/refs", params)
     end
@@ -113,7 +113,7 @@ module Github
       _validate_reference ref
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REF_PARAM_NAMES, params)
-      _validate_inputs(%w[ sha ], params)
+      assert_required_keys(%w[ sha ], params)
 
       patch_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
     end

data/lib/github_api/git_data/tags.rb

@@ -77,7 +77,7 @@ module Github
       _normalize_params_keys(params)
 
       _filter_params_keys(VALID_TAG_PARAM_NAMES, params)
-      _validate_params_values(VALID_TAG_PARAM_VALUES, params)
+      assert_valid_values(VALID_TAG_PARAM_VALUES, params)
 
       post_request("/repos/#{user}/#{repo}/git/tags", params)
     end

data/lib/github_api/git_data/trees.rb

@@ -89,11 +89,10 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _normalize_params_keys(params)
-
-      _validate_inputs(%w[ tree ], params)
+      assert_required_keys(%w[ tree ], params)
 
       _filter_params_keys(VALID_TREE_PARAM_NAMES, params['tree'])
-      _validate_params_values(VALID_TREE_PARAM_VALUES, params['tree'])
+      assert_valid_values(VALID_TREE_PARAM_VALUES, params['tree'])
 
       post_request("/repos/#{user}/#{repo}/git/trees", params)
     end

data/lib/github_api/issues.rb

@@ -82,11 +82,12 @@ module Github
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
-    def list(params={})
+    def list(*args)
+      params = args.extract_options!
       _normalize_params_keys(params)
       _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
       # _merge_mime_type(:issue, params)
-      _validate_params_values(VALID_ISSUE_PARAM_VALUES, params)
+      assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
 
       response = get_request("/issues", params)
       return response unless block_given?
@@ -124,15 +125,14 @@ module Github
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
-    # TODO: remove default nils from params
-    def list_repo(user_name=nil, repo_name=nil, params={})
+    def list_repo(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_ISSUE_PARAM_NAMES, params)
       # _merge_mime_type(:issue, params)
-      _validate_params_values(VALID_ISSUE_PARAM_VALUES, params)
+      assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
 
       response = get_request("/repos/#{user}/#{repo}/issues", params)
       return response unless block_given?
@@ -185,7 +185,7 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:issue, params)
       _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
-      _validate_inputs(%w[ title ], params)
+      assert_required_keys(%w[ title ], params)
 
       post_request("/repos/#{user}/#{repo}/issues", params)
     end

data/lib/github_api/issues/comments.rb

@@ -71,7 +71,7 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:issue_comment, params)
       _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
-      _validate_inputs(%w[ body ], params)
+      assert_required_keys(%w[ body ], params)
 
       post_request("/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)
-      _validate_inputs(%w[ body ], params)
+      assert_required_keys(%w[ body ], params)
 
       patch_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
     end

data/lib/github_api/issues/labels.rb

@@ -62,7 +62,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_LABEL_INPUTS, params)
-      _validate_inputs(VALID_LABEL_INPUTS, params)
+      assert_required_keys(VALID_LABEL_INPUTS, params)
 
       post_request("/repos/#{user}/#{repo}/labels", params)
     end
@@ -85,7 +85,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_LABEL_INPUTS, params)
-      _validate_inputs(VALID_LABEL_INPUTS, params)
+      assert_required_keys(VALID_LABEL_INPUTS, params)
 
       patch_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
     end

data/lib/github_api/issues/milestones.rb

@@ -44,7 +44,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_MILESTONE_OPTIONS.keys, params)
-      _validate_params_values(VALID_MILESTONE_OPTIONS, params)
+      assert_valid_values(VALID_MILESTONE_OPTIONS, params)
 
       response = get_request("/repos/#{user}/#{repo}/milestones", params)
       return response unless block_given?
@@ -89,7 +89,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_MILESTONE_INPUTS, params)
-      _validate_inputs(%w[ title ], params)
+      assert_required_keys(%w[ title ], params)
 
       post_request("/repos/#{user}/#{repo}/milestones", params)
     end
@@ -117,7 +117,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_MILESTONE_INPUTS, params)
-      _validate_inputs(%w[ title ], params)
+      assert_required_keys(%w[ title ], params)
 
       patch_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
     end

data/lib/github_api/orgs/teams.rb

@@ -65,8 +65,8 @@ module Github
       _validate_presence_of org_name
       _normalize_params_keys(params)
       _filter_params_keys(VALID_TEAM_PARAM_NAMES, params)
-      _validate_params_values(VALID_TEAM_PARAM_VALUES, params)
-      _validate_inputs(%w[ name ], params)
+      assert_valid_values(VALID_TEAM_PARAM_VALUES, params)
+      assert_required_keys(%w[ name ], params)
 
       post_request("/orgs/#{org_name}/teams", params)
     end
@@ -92,8 +92,8 @@ module Github
       _normalize_params_keys(params)
 
       _filter_params_keys(VALID_TEAM_PARAM_NAMES, params)
-      _validate_params_values(VALID_TEAM_PARAM_VALUES, params)
-      _validate_inputs(%w[ name ], params)
+      assert_valid_values(VALID_TEAM_PARAM_VALUES, params)
+      assert_required_keys(%w[ name ], params)
 
       patch_request("/teams/#{team_name}", params)
     end

data/lib/github_api/params_hash.rb

@@ -0,0 +1,31 @@
+module Github
+  class ParamsHash < ::Hash
+
+    def initialize(*args, &block)
+      hash = args.extract_options!
+      debugger
+      # debugger
+      # normalize_keys!(hash)
+      # debugger
+      super[hash]
+    end
+
+    def normalize_keys!(params)
+      case params
+      when Hash
+        params.keys.each do |k|
+          params[k.to_s] = params.delete(k)
+          normalize_keys!(params[k.to_s])
+        end
+      when Array
+        params.map! do |el|
+          normalize_keys!(el)
+        end
+      else
+        params.to_s
+      end
+      return params
+    end
+
+  end # ParamsHash
+end # Github