github_api 0.5.4 → 0.6.0

data/lib/github_api/pull_requests.rb

@@ -50,7 +50,7 @@ module Github
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
       # _merge_mime_type(:pull_request, params)
-      _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
+      assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
 
       response = get_request("/repos/#{user}/#{repo}/pulls", params)
       return response unless block_given?
@@ -141,7 +141,7 @@ module Github
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
       # _merge_mime_type(:pull_request, params)
-      _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
+      assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
 
       patch_request("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
     end

data/lib/github_api/pull_requests/comments.rb

@@ -134,10 +134,10 @@ module Github
 
     # To let user know that the params supplied are wrong before request is made
     def _validate_reply_to(params)
-      if params['in_reply_to'] && !_validate_inputs(%w[ body in_reply_to ], params)
+      if params['in_reply_to'] && !assert_required_keys(%w[ body in_reply_to ], params)
         raise ArgumentError, "Required params are: #{%w[ body in_reply_to].join(',')}"
 
-      elsif !_validate_inputs(VALID_REQUEST_COM_PARAM_NAMES - %w[ in_reply_to ], params)
+      elsif !assert_required_keys(VALID_REQUEST_COM_PARAM_NAMES - %w[ in_reply_to ], params)
         raise ArgumentError, "Required params are: #{VALID_REQUEST_COM_PARAM_NAMES.join(', ')}"
       end
     end

data/lib/github_api/repos.rb

@@ -8,6 +8,7 @@ module Github
     autoload_all 'github_api/repos',
       :Collaborators => 'collaborators',
       :Commits       => 'commits',
+      :Contents      => 'contents',
       :Downloads     => 'downloads',
       :Forks         => 'forks',
       :Hooks         => 'hooks',
@@ -51,6 +52,11 @@ module Github
       @commits ||= ApiFactory.new 'Repos::Commits'
     end
 
+    # Access to Repos::Contents API
+    def contents
+      @commits ||= ApiFactory.new 'Repos::Contents'
+    end
+
     # Access to Repos::Downloads API
     def downloads
       @downloads ||= ApiFactory.new 'Repos::Downloads'
@@ -136,12 +142,7 @@ module Github
       params = args.extract_options!
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REPO_OPTIONS + %w[ org ], params)
-
-#       if !_validate_inputs(%w[ name ], params)
-#         raise ArgumentError, "Required params are: :name"
-#       end
-
-      _validate_inputs(%w[ name ], params)
+      assert_required_keys(%w[ name ], params)
 
       # Requires authenticated user
       if (org = params.delete("org"))
@@ -201,10 +202,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REPO_OPTIONS, params)
-
-      unless _validate_inputs(%w[ name ], params)
-        raise ArgumentError, "Required params are: #{%w[ :name ] }"
-      end
+      assert_required_keys(%w[ name ], params)
 
       patch_request("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
     end

data/lib/github_api/repos/commits.rb

@@ -54,7 +54,7 @@ module Github
         _normalize_params_keys(params)
         _filter_params_keys(REQUIRED_COMMENT_PARAMS, params)
 
-        _validate_inputs(REQUIRED_COMMENT_PARAMS, params)
+        assert_required_keys(REQUIRED_COMMENT_PARAMS, params)
 
         post_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
       end
@@ -182,7 +182,7 @@ module Github
         _validate_presence_of comment_id
 
         _normalize_params_keys(params)
-        _validate_inputs(%w[ body ], params)
+        assert_required_keys(%w[ body ], params)
 
         patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end

data/lib/github_api/repos/contents.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module Github
+  class Repos::Contents < API
+    # These API methods let you retrieve the contents of files within a repository as Base64 encoded content
+
+    # Get the README
+    #
+    # This method returns the preferred README for a repository.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.contents.readme 'user-name', 'repo-name'
+    #
+    def readme(user_name, repo_name, params={})
+      _normalize_params_keys(params)
+
+      get_request("/repos/#{user_name}/#{repo_name}/readme", params)
+    end
+
+    # Get contents
+    #
+    # This method returns the contents of any file or directory in a repository.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.contents.get 'user-name', 'repo-name', 'path'
+    #
+    def get(user_name, repo_name, path, params={})
+      _normalize_params_keys(params)
+
+      get_request("/repos/#{user_name}/#{repo_name}/contents/#{path}", params)
+    end
+    alias :find :get
+
+    # Get archive link
+    #
+    # This method will return a 302 to a URL to download a tarball or zipball
+    # archive for a repository. Please make sure your HTTP framework is configured
+    # to follow redirects or you will need to use the Location header to make
+    # a second GET request.
+    #
+    # Note: For private repositories, these links are temporary and expire quickly.
+    #
+    # = Parameters
+    # * <tt>:archive_format</tt> - Required string - either tarball or zipball
+    # * <tt>:ref</tt> - Optional string - valid Git reference, defaults to master
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.contents.archive 'user-name', 'repo-name',
+    #    "archive_format" =>  "tarball",
+    #    "ref" => "master"
+    #
+    def archive(user_name, repo_name, params={})
+      _normalize_params_keys(params)
+      archive_format = params.delete('archive_format') || 'zipball'
+      ref = params.delete('ref') || 'master'
+
+      get_request("/repos/#{user_name}/#{repo_name}/#{archive_format}/#{ref}", params)
+    end
+
+  end # Repos::Contents
+end # Github

data/lib/github_api/repos/downloads.rb

@@ -87,7 +87,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_DOWNLOAD_PARAM_NAMES, params)
-      _validate_inputs(REQUIRED_PARAMS, params)
+      assert_required_keys(REQUIRED_PARAMS, params)
 
       post_request("/repos/#{user}/#{repo}/downloads", params)
     end

data/lib/github_api/repos/hooks.rb

@@ -92,7 +92,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_HOOK_PARAM_NAMES, params, :recursive => false)
-      _validate_inputs(REQUIRED_PARAMS, params)
+      assert_required_keys(REQUIRED_PARAMS, params)
 
       post_request("/repos/#{user}/#{repo}/hooks", params)
     end
@@ -125,7 +125,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_HOOK_PARAM_NAMES, params, :recursive => false)
-      _validate_inputs(REQUIRED_PARAMS, params)
+      assert_required_keys(REQUIRED_PARAMS, params)
 
       patch_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
     end

data/lib/github_api/repos/keys.rb

@@ -56,7 +56,7 @@ module Github
       _validate_user_repo_params(user, repo) unless user? && repo?
       _normalize_params_keys(params)
       _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
-      _validate_inputs(VALID_KEY_PARAM_NAMES, params)
+      assert_required_keys(VALID_KEY_PARAM_NAMES, params)
 
       post_request("/repos/#{user}/#{repo}/keys", params)
     end

data/lib/github_api/result.rb

@@ -15,6 +15,10 @@ module Github
       loaded? ? @env[:response_headers][RATELIMIT_REMAINING] : nil
     end
 
+    def cache_control
+      loaded? ? @env[:response_headers][CACHE_CONTROL] : nil
+    end
+
     def content_type
       loaded? ? @env[:response_headers][CONTENT_TYPE] : nil
     end
@@ -31,6 +35,10 @@ module Github
       loaded? ? @env[:response_headers][DATE] : nil
     end
 
+    def location
+      loaded? ? @env[:response_headers][LOCATION] : nil
+    end
+
     def server
       loaded? ? @env[:response_headers][SERVER] : nil
     end

data/lib/github_api/search.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module Github
+  class Search < API
+
+    # Creates new Search API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # Search issues
+    #
+    # Find issues by state and keyword.
+    #
+    # = Parameters
+    #  <tt>:state</tt> - open or closed.
+    #  <tt>:keyword</tt> - search term
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.search.issues owner: 'owner', repo: 'repo-name', state: 'open', keyword: 'api'
+    #
+    def issues(*args)
+      params = args.extract_options!
+      normalize params
+
+      required = ['owner', 'repo', 'state', 'keyword']
+      assert_required_keys required, params
+
+      options = required.inject({}) do |hash, key|
+        hash[key] = params.delete(key)
+        hash
+      end
+
+      get_request("/legacy/issues/search/#{options['owner']}/#{options['repo']}/#{options['state']}/#{options['keyword']}", params)
+    end
+
+    # Search repositories
+    #
+    # Find repositories by keyword.
+    #
+    # = Parameters
+    #  <tt>:keyword</tt> - search term
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.search.repos keyword: 'api'
+    #
+    def repos(*args)
+      params = args.extract_options!
+      normalize params
+      assert_required_keys %w[ keyword ], params
+
+      get_request("/legacy/repos/search/#{params.delete('keyword')}", params)
+    end
+    alias :repositories :repos
+
+    # Search users
+    #
+    # Find users by keyword.
+    #
+    # = Parameters
+    #  <tt>:keyword</tt> - search term
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.search.users keyword: 'wycats'
+    #
+    def users(*args)
+      params = args.extract_options!
+      normalize params
+      assert_required_keys %w[ keyword ], params
+
+      get_request("/legacy/user/search/#{params.delete('keyword')}", params)
+    end
+
+    # Search email
+    #
+    # This API call is added for compatibility reasons only. There’s no
+    # guarantee that full email searches will always be available.
+    #
+    # = Parameters
+    #  <tt>:keyword</tt> - search term
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.search.email email: 'wycats'
+    #
+    def email(*args)
+      params = args.extract_options!
+      normalize params
+      assert_required_keys %w[ email ], params
+
+      get_request("/legacy/user/email/#{params.delete('email')}", params)
+    end
+
+  end # Search
+end # Github

data/lib/github_api/users.rb

@@ -44,17 +44,18 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.users.get 'user-name'
+    #  github.users.get user: 'user-name'
     #
     # Get the authenticated user
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.users.get
+    #  github = Github.new oauth_token: '...'
+    #  github.users.get
     #
-    def get(user_name=nil, params={})
+    def get(*args)
+      params = args.extract_options!
       _normalize_params_keys(params)
-      if user_name
+      if user_name = params.delete('user')
         get_request("/users/#{user_name}", params)
       else
         get_request("/user", params)
@@ -84,7 +85,8 @@ module Github
     #    "hireable" => true,
     #    "bio" => "There once..."
     #
-    def update(params={})
+    def update(*args)
+      params = args.extract_options!
       _normalize_params_keys(params)
       _filter_params_keys(VALID_USER_PARAMS_NAMES, params)
       patch_request("/user", params)

data/lib/github_api/users/emails.rb

@@ -29,7 +29,7 @@ module Github
     #  github.users.emails.add "octocat@github.com", "support@github.com"
     #
     def add(*args)
-      params = _extract_parameters(args)
+      params = args.extract_options!
       _normalize_params_keys(params)
       params['data'] = args if args
       post_request("/user/emails", params)
@@ -46,7 +46,7 @@ module Github
     #  github.users.emails.delete "octocat@github.com", "support@github.com"
     #
     def delete(*args)
-      params = _extract_parameters(args)
+      params = args.extract_options!
       _normalize_params_keys(params)
       params['data'] = args if args
       delete_request("/user/emails", params)

data/lib/github_api/validations/format.rb

@@ -7,13 +7,14 @@ module Github
       # 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)
+      def assert_valid_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(', ')}"
+            raise Github::Error::UnknownValue.new(k,v, permitted[k].join(', '))
+
           elsif permitted[k].is_a?(Regexp) && !(permitted[k] =~ params[k])
-            raise ArgumentError, "String does not match the parameter value."
+            raise Github::Error::UnknownValue.new(k,v, permitted[k])
           end
         end
       end

data/lib/github_api/validations/required.rb

@@ -4,9 +4,12 @@ module Github
   module Validations
     module Required
 
-      # Ensures that esential input parameters are present before request is made.
+      # Validate all keys present in a provided hash against required set,
+      # on mismatch raise Github::Error::RequiredParams
+      # Note that keys need to be in the same format i.e. symbols or strings,
+      # otherwise the comparison will fail.
       #
-      def _validate_inputs(required, provided)
+      def assert_required_keys(required, provided)
         result = required.all? do |key|
           provided.has_deep_key? key
         end

data/lib/github_api/version.rb

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

data/spec/fixtures/repos/content.json

@@ -0,0 +1,14 @@
+{
+  "type": "file",
+  "encoding": "base64",
+  "_links": {
+    "git": "https://api.github.com/repos/pengwynn/octokit/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
+    "self": "https://api.github.com/repos/pengwynn/octokit/contents/README.md",
+    "html": "https://github.com/pengwynn/octokit/blob/master/README.md"
+  },
+  "size": 5362,
+  "name": "README.md",
+  "path": "README.md",
+  "content": "encoded content ...",
+  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1"
+}

data/spec/fixtures/repos/readme.json

@@ -0,0 +1,14 @@
+{
+  "type": "file",
+  "encoding": "base64",
+  "_links": {
+    "git": "https://api.github.com/repos/pengwynn/octokit/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
+    "self": "https://api.github.com/repos/pengwynn/octokit/contents/README.md",
+    "html": "https://github.com/pengwynn/octokit/blob/master/README.md"
+  },
+  "size": 5362,
+  "name": "README.md",
+  "path": "README.md",
+  "content": "encoded content ...",
+  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1"
+}