github_api 0.10.2 → 0.11.0

data/features/settings.yml

@@ -1,7 +1,4 @@
 ---
-oauth_token: 08e1475aa919c41b1b3c9d60e7808d252e559d47
-basic_auth: murek:Testing123
+oauth_token: token
+basic_auth: Murek:Testing123
 user: murek
-repo: github_api_test
-org:
-email: p_murek@wp.pl

data/features/step_definitions/github_api_steps.rb

@@ -12,6 +12,18 @@ Given /^I have "([^"]*)" instance$/ do |api_classes|
   )
 end
 
+Given /^I do not verify ssl$/ do
+  @instance.ssl = {:verify => false}
+end
+
+Given /^I set the following (?:attribute|attributes) of instance:$/ do |table|
+  table.hashes.each do |element|
+    element.each do |attr, val|
+      @instance.send(:"#{attr}=", val)
+    end
+  end
+end
+
 When /^I am not authorized$/ do
   [:basic_auth, :login, :password, :oauth_token].each do |attr|
     @instance.send("#{attr}=", nil)

data/lib/github_api/configuration.rb

@@ -51,7 +51,9 @@ module Github
     DEFAULT_SITE = 'https://github.com'.freeze
 
     # The default SSL configuration
-    DEFAULT_SSL = {}
+    DEFAULT_SSL = {
+      :ca_file => File.expand_path('../ssl_certs/cacerts.pem', __FILE__)
+    }
 
     # The value sent in the http header for 'User-Agent' if none is set
     DEFAULT_USER_AGENT = "Github Ruby Gem #{Github::VERSION::STRING}".freeze

data/lib/github_api/error.rb

@@ -28,21 +28,10 @@ module Github
   end # Error
 end # Github
 
-%w[
-  service_error
-  bad_request
-  unauthorized
-  forbidden
-  not_found
-  not_acceptable
-  unprocessable_entity
-  internal_server_error
-  service_unavailable
-  client_error
-  invalid_options
-  required_params
-  unknown_value
-  validations
-].each do |error|
-  require "github_api/error/#{error}"
+require 'github_api/error/service_error'
+require 'github_api/error/client_error'
+Dir[File.dirname(__FILE__) + '/error/*.rb'].sort.each do |path|
+  filename = File.basename(path)
+  next if ['service_error.rb', 'client_error.rb'].include?(filename)
+  require "github_api/error/#{filename}"
 end

data/lib/github_api/error/unknown_media.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class UnknownMedia < ClientError
+      def initialize(file)
+        super(
+          generate_message(
+            :problem => "Unknown content type for: '#{file}' provided for this request.",
+            :summary => "Github gem infers the content type of the resource by calling the mime-types gem type inference.",
+            :resolution => "Please install mime-types gem to infer the resource content type."
+          )
+        )
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/params_hash.rb

@@ -14,19 +14,25 @@ module Github
       super(normalize!(Hash[hash]))
     end
 
+    # Create empty hash
+    #
+    def self.empty
+      new({})
+    end
+
     # Extract and parse media type param
     #
     #  [.version].param[+json]
     #
     def media
-      parse(self.delete('media'))
+      parse(delete('media'))
     end
 
     # Return accept header if present
     #
     def accept
       if has_key?('accept')
-        self.delete('accept')
+        delete('accept')
       elsif has_key?('media')
         media
       else
@@ -34,26 +40,30 @@ module Github
       end
     end
 
-    # Extract request data from paramters
+    # Extract request data from parameters
     #
     def data
       if has_key?('data') && !self['data'].nil?
-        return self.delete('data')
+        return delete('data')
       else
-        return self.to_hash
+        return to_hash
       end
     end
 
     # Any client configuration options
     #
     def options
-      hash = has_key?('options') ? self.delete('options') : {}
+      opts = has_key?('options') ? delete('options') : {}
+      headers = opts.fetch(:headers) { {} }
       if value = accept
-        hash[:headers] = {} unless hash.has_key?(:headers)
-        hash[:headers]['Accept'] = value
+        headers[:accept] = value
+      end
+      if value = delete('content_type')
+        headers[:content_type] = value
       end
-      hash[:raw] = has_key?('raw') ? self.delete('raw') : false
-      hash
+      opts[:raw] = has_key?('raw') ? delete('raw') : false
+      opts[:headers] = headers unless headers.empty?
+      opts
     end
 
     # Update hash with default parameters for non existing keys

data/lib/github_api/repos.rb

@@ -16,6 +16,7 @@ module Github
       :Keys          => 'keys',
       :Merging       => 'merging',
       :PubSubHubbub  => 'pub_sub_hubbub',
+      :Releases      => 'releases',
       :Statistics    => 'statistics',
       :Statuses      => 'statuses'
 
@@ -52,7 +53,7 @@ module Github
 
     # Access to Repos::Comments API
     def comments(options={}, &block)
-      @commits ||= ApiFactory.new('Repos::Comments', current_options.merge(options), &block)
+      @comments ||= ApiFactory.new('Repos::Comments', current_options.merge(options), &block)
     end
 
     # Access to Repos::Commits API
@@ -87,7 +88,7 @@ module Github
 
     # Access to Repos::Merging API
     def merging(options={}, &block)
-      @mergin ||= ApiFactory.new('Repos::Merging', current_options.merge(options), &block)
+      @merging ||= ApiFactory.new('Repos::Merging', current_options.merge(options), &block)
     end
 
     # Access to Repos::PubSubHubbub API
@@ -95,6 +96,11 @@ module Github
       @pubsubhubbub ||= ApiFactory.new('Repos::PubSubHubbub', current_options.merge(options), &block)
     end
 
+    # Access to Repos::Releases API
+    def releases(options={}, &block)
+      @releases ||= ApiFactory.new('Repos::Releases', current_options.merge(options), &block)
+    end
+
     # Access to Repos::Statistics API
     def stats(options={}, &block)
       @stats ||= ApiFactory.new('Repos::Statistics', current_options.merge(options), &block)
@@ -143,15 +149,15 @@ module Github
       end
       params = arguments.params
 
-      response = if (user_name = (params.delete("user")))
+      response = if (user_name = params.delete('user') || user)
         get_request("/users/#{user_name}/repos", params)
-      elsif (org_name = (params.delete("org")))
+      elsif (org_name = params.delete('org') || org)
         get_request("/orgs/#{org_name}/repos", params)
-      elsif args.map(&:to_s).include?("every")
-        get_request("/repositories", params)
+      elsif args.map(&:to_s).include?('every')
+        get_request('/repositories', params)
       else
         # For authenticated user
-        get_request("/user/repos", params)
+        get_request('/user/repos', params)
       end
       return response unless block_given?
       response.each { |el| yield el }
@@ -180,11 +186,17 @@ module Github
     #  <tt>:name</tt> - Required string
     #  <tt>:description</tt> - Optional string
     #  <tt>:homepage</tt> - Optional string
-    #  <tt>:private</tt> - Optional boolean - <tt>true</tt> to create a private repository, <tt>false</tt> to create a public one.
-    #  <tt>:has_issues</tt> - Optional boolean - <tt>true</tt> to enable issues for this repository, <tt>false</tt> to disable them
-    #  <tt>:has_wiki</tt> - Optional boolean - <tt>true</tt> to enable the wiki for this repository, <tt>false</tt> to disable it. Default is <tt>true</tt>
-    #  <tt>:has_downloads</tt> Optional boolean - <tt>true</tt> to enable downloads for this repository
-    #  <tt>:org</tt> Optional string - The organisation in which this repository will be created
+    #  <tt>:private</tt> - Optional boolean - <tt>true</tt> to create a private
+    #                      repository, <tt>false</tt> to create a public one.
+    #  <tt>:has_issues</tt> - Optional boolean - <tt>true</tt> to enable issues
+    #                         for this repository, <tt>false</tt> to disable them
+    #  <tt>:has_wiki</tt> - Optional boolean - <tt>true</tt> to enable the wiki
+    #                       for this repository, <tt>false</tt> to disable it.
+    #                       Default is <tt>true</tt>
+    #  <tt>:has_downloads</tt> - Optional boolean - <tt>true</tt> to enable
+    #                            downloads for this repository
+    #  <tt>:org</tt> Optional string - The organisation in which this repository
+    #                                  will be created
     #  <tt>:team_id</tt> Optional number - The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization
     #  <tt>:auto_init</tt> Optional boolean - true to create an initial commit with empty README. Default is false.
     #  <tt>:gitignore_template</tt> Optional string - Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, “Haskell” Ignored if auto_init parameter is not provided.
@@ -214,10 +226,10 @@ module Github
       params = arguments.params
 
       # Requires authenticated user
-      if (org = params.delete("org"))
+      if (org = params.delete('org') || org)
         post_request("/orgs/#{org}/repos", params.merge_default(DEFAULT_REPO_OPTIONS))
       else
-        post_request("/user/repos", params.merge_default(DEFAULT_REPO_OPTIONS))
+        post_request('/user/repos', params.merge_default(DEFAULT_REPO_OPTIONS))
       end
     end
 
@@ -324,7 +336,6 @@ module Github
     # def branches(user_name, repo_name, params={})
     def branches(*args)
       arguments(args, :required => [:user, :repo])
-      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/branches", arguments.params)
       return response unless block_given?

data/lib/github_api/repos/releases.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+module Github
+
+  # The Releases API
+  class Repos::Releases < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/repos/releases',
+      :Assets => 'assets'
+
+    VALID_RELEASE_PARAM_NAMES = %w[
+      tag_name
+      target_commitish
+      name
+      body
+      draft
+      prerelease
+    ].freeze # :nodoc:
+
+    # Access to Repos::Releases::Assets API
+    def assets(options = {}, &block)
+      @assets ||= ApiFactory.new('Repos::Releases::Assets', current_options.merge(options), &block)
+    end
+
+    # 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.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.list 'owner', 'repo'
+    #  github.repos.releases.list 'owner', 'repo' { |release| ... }
+    #
+    def list(*args)
+      params = arguments(args, required: [:owner, :repo]).params
+      response = get_request("/repos/#{owner}/#{repo}/releases", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single release
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.get 'owner', 'repo', 'id'
+    #
+    def get(*args)
+      params = arguments(args, required: [:owner, :repo, :id]).params
+      get_request("/repos/#{owner}/#{repo}/releases/#{id}" , params)
+    end
+    alias :find :get
+
+    # Create a release
+    #
+    # = Inputs
+    # * <tt>:tag_name</tt> - Required string
+    # * <tt>:target_commitish</tt> - Optional string - Specifies the commitish
+    #       value that determines where the Git tag is created from. Can be
+    #       any branch or commit SHA. Defaults to the repository's default
+    #       branch (usually 'master'). Unused if the Git tag already exists.
+    # * <tt>:name</tt> - Optional string
+    # * <tt>:body</tt> - Optional string
+    # * <tt>:draft</tt> - Optional boolean - <tt>true</tt> to create a draft
+    #                    (unpublished) release, <tt>false</tt> to create
+    #                     a published one. Default is false.
+    # * <tt>:prerelease</tt> - Optional boolean - <tt>true</tt> to identify
+    #                       the release as a prerelease. false to identify
+    #                       the release as a full release. Default is false.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.create 'owner', 'repo', 'tag-name',
+    #    "tag_name": "v1.0.0",
+    #    "target_commitish": "master",
+    #    "name": "v1.0.0",
+    #    "body": "Description of the release",
+    #    "draft": false,
+    #    "prerelease": false
+    #
+    def create(*args)
+      arguments(args, required: [:owner, :repo, :tag_name]) do
+        sift VALID_RELEASE_PARAM_NAMES
+      end
+      params = arguments.params
+      params['tag_name'] = tag_name
+
+      post_request("/repos/#{owner}/#{repo}/releases", params)
+    end
+
+    # Edit a release
+    #
+    # = Inputs
+    # * <tt>:tag_name</tt> - Required string
+    # * <tt>:target_commitish</tt> - Optional string - Specifies the commitish
+    #       value that determines where the Git tag is created from. Can be
+    #       any branch or commit SHA. Defaults to the repository's default
+    #       branch (usually 'master'). Unused if the Git tag already exists.
+    # * <tt>:name</tt> - Optional string
+    # * <tt>:body</tt> - Optional string
+    # * <tt>:draft</tt> - Optional boolean - <tt>true</tt> to create a draft
+    #                    (unpublished) release, <tt>false</tt> to create
+    #                     a published one. Default is false.
+    # * <tt>:prerelease</tt> - Optional boolean - <tt>true</tt> to identify
+    #                       the release as a prerelease. false to identify
+    #                       the release as a full release. Default is false.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.edit 'owner', 'repo', 'id',
+    #    "tag_name": "v1.0.0",
+    #    "target_commitish": "master",
+    #    "name": "v1.0.0",
+    #    "body": "Description of the release",
+    #    "draft": false,
+    #    "prerelease": false
+    #
+    def edit(*args)
+      arguments(args, required: [:owner, :repo, :id]) do
+        sift VALID_RELEASE_PARAM_NAMES
+      end
+      params = arguments.params
+
+      patch_request("/repos/#{owner}/#{repo}/releases/#{id}", params)
+    end
+    alias :update :edit
+
+    # Delete a release
+    #
+    # Users with push access to the repository can delete a release.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.delete 'owner', 'repo', 'id'
+    #
+    def delete(*args)
+      params = arguments(args, required: [:owner, :repo, :id]).params
+
+      delete_request("/repos/#{owner}/#{repo}/releases/#{id}", params)
+    end
+
+  end # Repos::Statuses
+end # Github

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

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+module Github
+
+  # The Release Assets API
+  class Repos::Releases::Assets < API
+
+    VALID_ASSET_PARAM_NAMES = %w[
+      name
+      label
+      content_type
+    ].freeze # :nodoc:
+
+    # List assets for a release
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.assets.list 'owner', 'repo', 'id'
+    #  github.repos.releases.assets.list 'owner', 'repo', 'id' { |asset| ... }
+    #
+    def list(*args)
+      params = arguments(args, required: [:owner, :repo, :id]).params
+
+      response = get_request("/repos/#{owner}/#{repo}/releases/#{id}/assets", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single release asset
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.assets.get 'owner', 'repo', 'id'
+    #
+    def get(*args)
+      params = arguments(args, required: [:owner, :repo, :id]).params
+
+      get_request("/repos/#{owner}/#{repo}/releases/assets/#{id}" , params)
+    end
+    alias :find :get
+
+    # Upload a release asset
+    #
+    # = Inputs
+    # * <tt>:name</tt> - Required string - The file name of the asset
+    # * <tt>:content_type</tt> - Required string - The content type
+    #                            of the asset. Example: “application/zip”.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.assets.upload 'owner', 'repo', 'id', 'file-path'
+    #    "name": "batman.jpg",
+    #    "content_type": "application/octet-stream"
+    #
+    def upload(*args)
+      arguments(args, required: [:owner, :repo, :id, :filepath]) do
+        sift VALID_ASSET_PARAM_NAMES
+      end
+      params = arguments.params
+
+      unless type = params['content_type']
+        type = infer_media(filepath)
+      end
+
+      file = Faraday::UploadIO.new(filepath, type)
+      options = {
+        headers: { content_type: type },
+        endpoint: 'https://uploads.github.com',
+        query: {'name' => params['name']}
+      }
+      params['data']    = file.read
+      params['options'] = options
+
+      post_request("/repos/#{owner}/#{repo}/releases/#{id}/assets", params)
+    ensure
+      file.close if file
+    end
+
+    # Infer media type of the asset
+    #
+    def infer_media(filepath)
+      require 'mime/types'
+      types = MIME::Types.type_for(filepath)
+      types.empty? ? 'application/octet-stream' : types.first
+    rescue LoadError
+      raise Github::Error::UnknownMedia.new(filepath)
+    end
+
+    # Edit a release asset
+    #
+    # = Inputs
+    # * <tt>:name</tt>  - Required string - the filename of the asset
+    # * <tt>:label</tt> - Optional string - An alternate short description of
+    #                     the asset. Used in place of the filename.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.assets.edit 'owner', 'repo', 'id',
+    #    "name": "foo-1.0.0-osx.zip",
+    #    "label": "Mac binary"
+    #
+    def edit(*args)
+      arguments(args, required: [:owner, :repo, :id]) do
+        sift VALID_ASSET_PARAM_NAMES
+      end
+      params = arguments.params
+
+      patch_request("/repos/#{owner}/#{repo}/releases/assets/#{id}", params)
+    end
+    alias :update :edit
+
+    # Delete a release asset
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.releases.assets.delete 'owner', 'repo', 'id'
+    #
+    def delete(*args)
+      params = arguments(args, required: [:owner, :repo, :id]).params
+
+      delete_request("/repos/#{owner}/#{repo}/releases/assets/#{id}", params)
+    end
+
+  end # Repos::Statuses
+end # Github