github_api 0.12.4 → 0.13.0

data/lib/github_api/client/repos/commits.rb

@@ -19,7 +19,7 @@ module Github
     # @option params [String] :path
     #   Only commits containing this file path will be returned.
     # @option params [String] :author
-    #   GitHub login, name, or email by which to filter by commit author.
+    #   GitHub login, name or email by which to filter by commit author.
     # @option params [String] :since
     #   Only commits after this date will be returned. This is a timestamp
     #   in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
@@ -48,7 +48,7 @@ module Github
     #
     # @example
     #  github = Github.new
-    #  github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
+    #  github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6'
     #
     # @api public
     def get(*args)

data/lib/github_api/client/repos/keys.rb

@@ -2,11 +2,13 @@
 
 module Github
   class Client::Repos::Keys < API
-
-    VALID_KEY_OPTIONS = %w[ title key ].freeze
-
     # List deploy keys
     #
+    # @see https://developer.github.com/v3/repos/keys/#list
+    #
+    # @param [String] :user
+    # @param [String :repo
+    #
     # @example
     #   github = Github.new
     #   github.repos.keys.list 'user-name', 'repo-name'
@@ -20,33 +22,47 @@ module Github
     def list(*args)
       arguments(args, required: [:user, :repo])
 
-      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/keys", arguments.params)
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/keys",
+                             arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # Get a key
     #
+    # @see https://developer.github.com/v3/repos/keys/#get
+    #
+    # @param [String] :user
+    # @param [String] :repo
+    # @param [Integer] :id
+    #
     # @example
     #   github = Github.new
     #   github.repos.keys.get 'user-name', 'repo-name', 'key-id'
     #
     # @api public
     def get(*args)
-      arguments(args, :required => [:user, :repo, :id])
+      arguments(args, required: [:user, :repo, :id])
 
       get_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.id}", arguments.params)
     end
-    alias :find :get
+    alias_method :find, :get
 
     # Create a key
     #
+    # @see https://developer.github.com/v3/repos/keys/#create
+    #
+    # @param [String] :user
+    # @param [String] :repo
     # @param [Hash] params
     # @option params [String] :title
     #   Required string.
     # @option params [String] :key
     #   Required string.
+    # @option params [String] :read_only
+    #   If true, the key will only be able to read repository contents.
+    #   Otherwise, the key will be able to read and write.
     #
     # @example
     #   github = Github.new
@@ -56,16 +72,21 @@ module Github
     #
     # @api public
     def create(*args)
-      arguments(args, required: [:user, :repo]) do
-        permit VALID_KEY_OPTIONS
-        assert_required VALID_KEY_OPTIONS
-      end
+      arguments(args, required: [:user, :repo])
 
-      post_request("/repos/#{arguments.user}/#{arguments.repo}/keys", arguments.params)
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/keys",
+                   arguments.params)
     end
+    alias_method :add, :create
 
     # Delete key
     #
+    # @see https://developer.github.com/v3/repos/keys/#delete
+    #
+    # @param [String] :user
+    # @param [String] :repo
+    # @param [Integer] :id
+    #
     # @example
     #   github = Github.new
     #   github.repos.keys.delete 'user-name', 'repo-name', 'key-id'
@@ -73,9 +94,9 @@ module Github
     # @api public
     def delete(*args)
       arguments(args, required: [:user, :repo, :id])
-      params = arguments.params
 
-      delete_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.id}", params)
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.id}", arguments.params)
     end
+    alias_method :remove, :delete
   end # Client::Repos::Keys
 end # Github

data/lib/github_api/client/repos/releases.rb

@@ -4,26 +4,22 @@ module Github
   # The Releases API
   class Client::Repos::Releases < API
 
-    require_all 'github_api/client/repos/releases', 'assets'
-
-    VALID_RELEASE_PARAM_NAMES = %w[
-      tag_name
-      target_commitish
-      name
-      body
-      draft
-      prerelease
-    ].freeze # :nodoc:
+    require_all 'github_api/client/repos/releases', 'assets', 'tags'
 
     # Access to Repos::Releases::Assets API
     namespace :assets
 
+    # Access to Repos::Releases::Tags API
+    namespace :tags
+
     # List releases for a repository
     #
     # Users with push access to the repository will receive all releases
     # (i.e., published releases and draft releases). Users with pull access
     # will receive published releases only.
     #
+    # @see https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository
+    #
     # @example
     #   github = Github.new
     #   github.repos.releases.list 'owner', 'repo'
@@ -31,16 +27,18 @@ module Github
     #
     # @api public
     def list(*args)
-      arguments(args, required: [:owner, :repo]).params
+      arguments(args, required: [:owner, :repo])
 
       response = get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # Get a single release
     #
+    # @see https://developer.github.com/v3/repos/releases/#get-a-single-release
+    #
     # @example
     #   github = Github.new
     #   github.repos.releases.get 'owner', 'repo', 'id'
@@ -48,12 +46,17 @@ module Github
     # @api public
     def get(*args)
       arguments(args, required: [:owner, :repo, :id]).params
+
       get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/#{arguments.id}" , arguments.params)
     end
-    alias :find :get
+    alias_method :find, :get
 
     # Create a release
     #
+    # Users with push access to the repository can create a release.
+    #
+    # @see https://developer.github.com/v3/repos/releases/#create-a-release
+    #
     # @param [Hash] params
     # @input params [String] :tag_name
     #   Required. The name of the tag.
@@ -75,7 +78,7 @@ module Github
     #
     # @example
     #   github = Github.new
-    #   github.repos.releases.create 'owner', 'repo', 'tag-name',
+    #   github.repos.releases.create 'owner', 'repo',
     #     tag_name: "v1.0.0",
     #     target_commitish: "master",
     #     name: "v1.0.0",
@@ -85,17 +88,23 @@ module Github
     #
     # @api public
     def create(*args)
-      arguments(args, required: [:owner, :repo, :tag_name]) do
-        permit VALID_RELEASE_PARAM_NAMES
+      arguments(args, required: [:owner, :repo]) do
+        assert_required :tag_name
       end
-      params = arguments.params
-      params['tag_name'] = arguments.tag_name
 
-      post_request("/repos/#{arguments.owner}/#{arguments.repo}/releases", params)
+      post_request("/repos/#{arguments.owner}/#{arguments.repo}/releases",
+                   arguments.params)
     end
 
     # Edit a release
     #
+    # Users with push access to the repository can edit a release.
+    #
+    # @see https://developer.github.com/v3/repos/releases/#edit-a-release
+    #
+    # @param [String] :owner
+    # @param [String] :repo
+    # @param [Integer] :id
     # @param [Hash] params
     # @input params [String] :tag_name
     #   Required. The name of the tag.
@@ -127,18 +136,22 @@ module Github
     #
     # @api public
     def edit(*args)
-      arguments(args, required: [:owner, :repo, :id]) do
-        permit VALID_RELEASE_PARAM_NAMES
-      end
+      arguments(args, required: [:owner, :repo, :id])
 
       patch_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/#{arguments.id}", arguments.params)
     end
-    alias :update :edit
+    alias_method :update, :edit
 
     # Delete a release
     #
     # Users with push access to the repository can delete a release.
     #
+    # @see https://developer.github.com/v3/repos/releases/#delete-a-release
+    #
+    # @param [String] :owner
+    # @param [String] :repo
+    # @param [Integer] :id
+    #
     # @example
     #   github = Github.new
     #   github.repos.releases.delete 'owner', 'repo', 'id'
@@ -149,5 +162,26 @@ module Github
 
       delete_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/#{arguments.id}", arguments.params)
     end
+
+    # Get the latest release
+    #
+    # View the latest published full release for the repository.
+    # Draft releases and prereleases are not returned.
+    #
+    # @see https://developer.github.com/v3/repos/releases/#get-the-latest-release
+    #
+    # @param [String] :owner
+    # @param [String] :repo
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.latest 'owner', 'repo'
+    #
+    # @api public
+    def latest(*args)
+      arguments(args, required: [:owner, :repo]).params
+
+      get_request("repos/#{arguments.owner}/#{arguments.repo}/releases/latest", arguments.params)
+    end
   end # Client::Repos::Statuses
 end # Github

data/lib/github_api/client/repos/releases/tags.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Github
+  # The Releases API
+  class Client::Repos::Releases::Tags < API
+    # Get a published release with the specified tag.
+    #
+    # @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.tags.get 'owner', 'repo', 'tag'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:owner, :repo, :tag]).params
+
+      get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/tags/#{arguments.tag}" , arguments.params)
+    end
+    alias_method :find, :get
+  end # Client::Repos::Releases::Tags
+end # Github

data/lib/github_api/configuration.rb

@@ -39,7 +39,7 @@ module Github
     property  :mime_type
 
     # The value sent in the http header for 'User-Agent' if none is set
-    property  :user_agent, default: "Github API Ruby Gem #{Github::VERSION::STRING}".freeze
+    property  :user_agent, default: "Github API Ruby Gem #{Github::VERSION}".freeze
 
     # By default uses the Faraday connection options if none is set
     property  :connection_options, default: {}

data/lib/github_api/validations/required.rb

@@ -3,22 +3,17 @@
 module Github
   module Validations
     module Required
-
       # 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 assert_required_keys(required, provided)
-        result = required.all? do |key|
-          provided.deep_key? key
-        end
-        if !result
-          raise Github::Error::RequiredParams.new(provided, required)
-        end
-        result
+      # @api public
+      def assert_required_keys(*required, provided)
+        required.flatten.all? { |key|
+          provided.deep_key?(key.to_s)
+        } || (raise Github::Error::RequiredParams.new(provided, required))
       end
-
     end # Required
   end # Validations
 end # Github

data/lib/github_api/version.rb

@@ -1,12 +1,5 @@
 # encoding: utf-8
 
 module Github
-  module VERSION
-    MAJOR = 0
-    MINOR = 12
-    PATCH = 4
-    BUILD = nil
-
-    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
-  end
+  VERSION = "0.13.0"
 end # Github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.13.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -179,6 +179,7 @@ files:
 - lib/github_api/client/markdown.rb
 - lib/github_api/client/meta.rb
 - lib/github_api/client/orgs/members.rb
+- lib/github_api/client/orgs/memberships.rb
 - lib/github_api/client/orgs/teams.rb
 - lib/github_api/client/orgs.rb
 - lib/github_api/client/pull_requests/comments.rb
@@ -196,6 +197,7 @@ files:
 - lib/github_api/client/repos/pages.rb
 - lib/github_api/client/repos/pub_sub_hubbub.rb
 - lib/github_api/client/repos/releases/assets.rb
+- lib/github_api/client/repos/releases/tags.rb
 - lib/github_api/client/repos/releases.rb
 - lib/github_api/client/repos/statistics.rb
 - lib/github_api/client/repos/statuses.rb