github_api 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8762ba3a592b9f1ad2f523a8cf8259350755350c
-  data.tar.gz: 3fe0fe09e1afad532bbf9238fb6096bd653c1a50
+  metadata.gz: b428d8782ec8d52580f70a96939c878db0cdf4ec
+  data.tar.gz: 578c3e1c036ec22952d056349972057d5518a48a
 SHA512:
-  metadata.gz: 80323205b6a85c10d0097661da59785fb23a36873efb03179bf4c94bf25349d0bfc23825db0d49a7c80725765bd96291e4f28693fe2f2392dadc3543ab0a08bd
-  data.tar.gz: eda22421e5cba3767aeb28c655b62096e82c6c389e202d549dd795adc301103f57e7ac78c1bf76f89bca2dc22e8fb586d1881751a08de7dee42a41870b117b82
+  metadata.gz: 57cd89c6a9f21ffbbb1e036894de9ac9a43fb7d1eb33a9bee31e27c9b5c6a956b6d9591cf0a15fde0fcb219f730b8ab0608b867f4d7d18066ecff6e7d2c2bd9d
+  data.tar.gz: 606683bd7c29321ece30e435c84720d3d426f53c1116bb510c171f1683a3f48f7aebb4aeb3ff32e4ed86c4e003d3ce1025c314f9d82911ebcafd911c1b33c9dc

data/README.md

@@ -681,6 +681,10 @@ The `mock` tests are in the `spec` directory and their primary concern is to tes
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/piotrmurach/github/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/github. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
 ## Copyright
 
 Copyright (c) 2011-2016 Piotr Murach. See LICENSE.txt for further details.

data/lib/github_api.rb

@@ -65,7 +65,6 @@ module Github
   end
 
   module ClassMethods
-
     # Requires internal libraries
     #
     # @param [String] prefix
@@ -88,6 +87,7 @@ module Github
     def configuration
       @configuration ||= Configuration.new
     end
+    alias_method :config, :configuration
 
     # Configure options
     #

data/lib/github_api/api.rb

@@ -17,6 +17,7 @@ module Github
   # Core class responsible for api interface operations
   class API
     extend Github::ClassMethods
+
     include Constants
     include Authorization
     include MimeType
@@ -43,36 +44,38 @@ module Github
     #
     # @api public
     def initialize(options={}, &block)
-      setup(options)
+      opts = Github.configuration.fetch.merge(options)
+      @current_options = opts
+
+      Github.configuration.property_names.each do |key|
+        send("#{key}=", opts[key])
+      end
+      if opts.key?(:login) && !opts[:login].nil?
+        @login, @password = opts[:login], opts[:password]
+      elsif opts.key?(:basic_auth) && !opts[:basic_auth].nil?
+        @login, @password = extract_basic_auth(opts[:basic_auth])
+      end
+
       yield_or_eval(&block) if block_given?
     end
 
+    # Call block with argument
+    #
+    # @api private
     def yield_or_eval(&block)
       return unless block
       block.arity > 0 ? yield(self) : self.instance_eval(&block)
     end
 
-    # Configure options and process basic authorization
-    #
-    # @api private
-    def setup(options={})
-      options = Github.configuration.fetch.merge(options)
-      self.current_options = options
-      Github.configuration.property_names.each do |key|
-        send("#{key}=", options[key])
-      end
-      process_basic_auth(options[:basic_auth])
-    end
-
     # Extract login and password from basic_auth parameter
     #
-    def process_basic_auth(auth)
+    # @api private
+    def extract_basic_auth(auth)
       case auth
       when String
-        self.login, self.password = auth.split(':', 2)
+        auth.split(':', 2)
       when Hash
-        self.login    = auth[:login]
-        self.password = auth[:password]
+        [auth[:login], auth[:password]]
       end
     end
 

data/lib/github_api/authorization.rb

@@ -56,13 +56,13 @@ module Github
     end
 
     # Select authentication parameters
+    #
+    # @api public
     def authentication
-      if basic_auth?
-        { :basic_auth => basic_auth }
-      elsif login? && password?
-        { :login => login, :password => password }
+      if basic_authed?
+        { login: login, password: password }
       else
-        { }
+        {}
       end
     end
 
@@ -71,6 +71,5 @@ module Github
     def _verify_client # :nodoc:
       raise ArgumentError, 'Need to provide client_id and client_secret' unless client_id? && client_secret?
     end
-
   end # Authorization
 end # Github

data/lib/github_api/client/orgs.rb

@@ -5,6 +5,7 @@ module Github
   class Client::Orgs < API
 
     require_all 'github_api/client/orgs',
+                'hooks',
                 'members',
                 'memberships',
                 'teams'

data/lib/github_api/client/orgs/hooks.rb

@@ -0,0 +1,180 @@
+# encoding: utf-8
+
+module Github
+  # The Organizations Hooks API manages the post-receive web and
+  # service hooks for an organization.
+  class Client::Orgs::Hooks < API
+
+    REQUIRED_PARAMS = %w( name config ).freeze # :nodoc:
+
+    # List organization hooks
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#list-hooks
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.list 'org-name'
+    #   github.orgs.hooks.list 'org-name' { |hook| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:org_name])
+
+      response = get_request("/orgs/#{arguments.org_name}/hooks", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#get-single-hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.get 'org-name', 'hook-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:org_name, :id])
+
+      get_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
+                  arguments.params)
+    end
+    alias_method :find, :get
+
+    # Create a hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#create-a-hook
+    #
+    # @param [Hash] params
+    # @input params [String] :name
+    #   Required. The name of the service that is being called.
+    # @input params [Hash] :config
+    #   Required. Key/value pairs to provide settings for this hook.
+    #   These settings vary between the services and are defined in
+    #   the github-services repository. Booleans are stored internally
+    #   as "1" for true, and "0" for false. Any JSON true/false values
+    #   will be converted automatically.
+    # @input params [Array] :events
+    #   Determines what events the hook is triggered for. Default: ["push"]
+    # @input params [Boolean] :active
+    #   Determines whether the hook is actually triggered on pushes.
+    #
+    # To create a webhook, the following fields are required by the config:
+    #
+    # @input config [String] :url
+    #   A required string defining the URL to which the payloads
+    #   will be delivered.
+    # @input config [String] :content_type
+    #   An optional string defining the media type used to serialize
+    #   the payloads. Supported values include json and form.
+    #   The default is form.
+    # @input config [String] :secret
+    #   An optional string that’s passed with the HTTP requests as
+    #   an X-Hub-Signature header. The value of this header is
+    #   computed as the HMAC hex digest of the body,
+    #   using the secret as the key.
+    # @input config [String] :insecure_ssl
+    #   An optional string that determines whether the SSL certificate
+    #   of the host for url will be verified when delivering payloads.
+    #   Supported values include "0" (verification is performed) and
+    #   "1" (verification is not performed). The default is "0".or instance, if the library doesn't get updated to permit a given parameter the api call won't work, however if we skip permission all together, the endpoint should always work provided the actual resource path doesn't change. I'm in the process of completely removing the permit functionality.
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.create 'org-name',
+    #     name:  "web",
+    #     active: true,
+    #     config: {
+    #       url: "http://something.com/webhook"
+    #     }
+    #   }
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:org_name]) do
+        assert_required REQUIRED_PARAMS
+      end
+
+      post_request("/orgs/#{arguments.org_name}/hooks", arguments.params)
+    end
+
+    # Edit a hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#edit-a-hook
+    #
+    # @param [Hash] params
+    # @input params [Hash] :config
+    #   Required. Key/value pairs to provide settings for this hook.
+    #   These settings vary between the services and are defined in
+    #   the github-services repository. Booleans are stored internally
+    #   as "1" for true, and "0" for false. Any JSON true/false values
+    #   will be converted automatically.
+    # @input params [Array] :events
+    #   Determines what events the hook is triggered for. Default: ["push"]
+    # @input params [Array] :add_events
+    #   Determines a list of events to be added to the list of events
+    #   that the Hook triggers for.
+    # @input params [Array] :remove_events
+    #   Determines a list of events to be removed from the list of
+    #   events that the Hook triggers for.
+    # @input params [Boolean] :active
+    #   Determines whether the hook is actually triggered on pushes.
+    #
+    # @example
+    #  github = Github.new
+    #  github.orgs.hooks.edit 'org-name', 'hook-id',
+    #    "name" => "campfire",
+    #    "active" =>  true,
+    #    "config" =>  {
+    #      "subdomain" => "github",
+    #      "room" =>  "Commits",
+    #      "token" => "abc123"
+    #    }
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:org_name, :id]) do
+        assert_required REQUIRED_PARAMS
+      end
+
+      patch_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
+                    arguments.params)
+    end
+
+    # Ping a hook
+    #
+    # This will trigger a ping event to be sent to the hook.
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.ping 'org-name', 'hook-id'
+    #
+    # @api public
+    def ping(*args)
+      arguments(args, required: [:org_name, :id])
+
+      post_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}/pings",
+                   arguments.params)
+    end
+
+    # Delete a hook
+    #
+    # @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.hooks.delete 'org-name', 'hook-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:org_name, :id])
+
+      delete_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
+                     arguments.params)
+    end
+  end # Client::Orgs::Hooks
+end # Github

data/lib/github_api/client/orgs/members.rb

@@ -83,12 +83,11 @@ module Github
       response.status == 204
     rescue Github::Error::NotFound
       false
-
     end
     # Remove a member
     #
     # Removing a user from this list will remove them from all teams and
-    # they will no longer have any access to the organization’s repositories.
+    # they will no longer have any access to the organization's repositories.
     #
     # @see https://developer.github.com/v3/orgs/members/#remove-a-member
     #
@@ -119,8 +118,8 @@ module Github
 
       put_request("/orgs/#{arguments.org_name}/public_members/#{arguments.user}", arguments.params)
     end
-    alias :make_public :publicize
-    alias :publicize_membership :publicize
+    alias_method :make_public, :publicize
+    alias_method :publicize_membership, :publicize
 
     # Conceal a user's membership
     #

data/lib/github_api/request/basic_auth.rb

@@ -8,25 +8,28 @@ module Github
     class BasicAuth < Faraday::Middleware
       dependency 'base64'
 
-      def call(env)
-        unless @auth.to_s.empty?
-          env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
-        end
-
-        @app.call env
-      end
-
+      # @api private
       def initialize(app, *args)
-        @app = app
-        credentials = ""
+        @app    = app
+        @auth   = nil
         options = args.extract_options!
-        if options.has_key? :login
+
+        if options.key?(:login) && !options[:login].nil?
           credentials = "#{options[:login]}:#{options[:password]}"
-        elsif options.has_key? :basic_auth
-          credentials = "#{options[:basic_auth]}"
+          @auth = Base64.encode64(credentials)
+          @auth.gsub!("\n", "")
         end
-        @auth = Base64.encode64(credentials)
-        @auth.gsub!("\n", "")
+      end
+
+      # Update request headers
+      #
+      # @api private
+      def call(env)
+        if @auth
+          env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
+        end
+
+        @app.call(env)
       end
     end # BasicAuth
   end # Request

data/lib/github_api/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Github
-  VERSION = "0.14.0"
+  VERSION = "0.14.1"
 end # Github

metadata

@@ -1,123 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-22 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: descendants_tracker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ' Ruby client that supports all of the GitHub API methods. It''s build
+description: " Ruby client that supports all of the GitHub API methods. It's build
   in a modular way, that is, you can either instantiate the whole api wrapper Github.new
   or use parts of it e.i. Github::Client::Repos.new if working solely with repositories
-  is your main concern. Intuitive query methods allow you easily call API endpoints. '
+  is your main concern. Intuitive query methods allow you easily call API endpoints. "
 email: ''
 executables: []
 extensions: []
@@ -125,46 +125,52 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- LICENSE.txt
+- README.md
+- lib/github_api.rb
+- lib/github_api/api.rb
 - lib/github_api/api/actions.rb
 - lib/github_api/api/arguments.rb
+- lib/github_api/api/config.rb
 - lib/github_api/api/config/property.rb
 - lib/github_api/api/config/property_set.rb
-- lib/github_api/api/config.rb
 - lib/github_api/api/factory.rb
-- lib/github_api/api.rb
 - lib/github_api/authorization.rb
+- lib/github_api/client.rb
+- lib/github_api/client/activity.rb
 - lib/github_api/client/activity/events.rb
 - lib/github_api/client/activity/feeds.rb
 - lib/github_api/client/activity/notifications.rb
 - lib/github_api/client/activity/starring.rb
 - lib/github_api/client/activity/watching.rb
-- lib/github_api/client/activity.rb
-- lib/github_api/client/authorizations/app.rb
 - lib/github_api/client/authorizations.rb
+- lib/github_api/client/authorizations/app.rb
 - lib/github_api/client/emojis.rb
-- lib/github_api/client/gists/comments.rb
 - lib/github_api/client/gists.rb
+- lib/github_api/client/gists/comments.rb
+- lib/github_api/client/git_data.rb
 - lib/github_api/client/git_data/blobs.rb
 - lib/github_api/client/git_data/commits.rb
 - lib/github_api/client/git_data/references.rb
 - lib/github_api/client/git_data/tags.rb
 - lib/github_api/client/git_data/trees.rb
-- lib/github_api/client/git_data.rb
 - lib/github_api/client/gitignore.rb
+- lib/github_api/client/issues.rb
 - lib/github_api/client/issues/assignees.rb
 - lib/github_api/client/issues/comments.rb
 - lib/github_api/client/issues/events.rb
 - lib/github_api/client/issues/labels.rb
 - lib/github_api/client/issues/milestones.rb
-- lib/github_api/client/issues.rb
 - lib/github_api/client/markdown.rb
 - lib/github_api/client/meta.rb
+- lib/github_api/client/orgs.rb
+- lib/github_api/client/orgs/hooks.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
 - lib/github_api/client/pull_requests.rb
+- lib/github_api/client/pull_requests/comments.rb
+- lib/github_api/client/repos.rb
 - lib/github_api/client/repos/collaborators.rb
 - lib/github_api/client/repos/comments.rb
 - lib/github_api/client/repos/commits.rb
@@ -177,21 +183,19 @@ files:
 - lib/github_api/client/repos/merging.rb
 - lib/github_api/client/repos/pages.rb
 - lib/github_api/client/repos/pub_sub_hubbub.rb
+- lib/github_api/client/repos/releases.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
-- lib/github_api/client/repos.rb
 - lib/github_api/client/say.rb
 - lib/github_api/client/scopes.rb
-- lib/github_api/client/search/legacy.rb
 - lib/github_api/client/search.rb
+- lib/github_api/client/search/legacy.rb
+- lib/github_api/client/users.rb
 - lib/github_api/client/users/emails.rb
 - lib/github_api/client/users/followers.rb
 - lib/github_api/client/users/keys.rb
-- lib/github_api/client/users.rb
-- lib/github_api/client.rb
 - lib/github_api/configuration.rb
 - lib/github_api/connection.rb
 - lib/github_api/constants.rb
@@ -199,6 +203,7 @@ files:
 - lib/github_api/core_ext/hash.rb
 - lib/github_api/core_ext/ordered_hash.rb
 - lib/github_api/deprecation.rb
+- lib/github_api/error.rb
 - lib/github_api/error/bad_request.rb
 - lib/github_api/error/client_error.rb
 - lib/github_api/error/forbidden.rb
@@ -214,7 +219,6 @@ files:
 - lib/github_api/error/unknown_value.rb
 - lib/github_api/error/unprocessable_entity.rb
 - lib/github_api/error/validations.rb
-- lib/github_api/error.rb
 - lib/github_api/ext/faraday.rb
 - lib/github_api/middleware.rb
 - lib/github_api/mime_type.rb
@@ -227,32 +231,29 @@ files:
 - lib/github_api/parameter_filter.rb
 - lib/github_api/params_hash.rb
 - lib/github_api/rate_limit.rb
+- lib/github_api/request.rb
 - lib/github_api/request/basic_auth.rb
 - lib/github_api/request/jsonize.rb
 - lib/github_api/request/oauth2.rb
 - lib/github_api/request/verbs.rb
-- lib/github_api/request.rb
 - lib/github_api/requestable.rb
 - lib/github_api/resource.rb
+- lib/github_api/response.rb
 - lib/github_api/response/atom_parser.rb
 - lib/github_api/response/header.rb
 - lib/github_api/response/jsonize.rb
 - lib/github_api/response/mashify.rb
 - lib/github_api/response/raise_error.rb
 - lib/github_api/response/xmlize.rb
-- lib/github_api/response.rb
 - lib/github_api/response_wrapper.rb
 - lib/github_api/ssl_certs/cacerts.pem
 - lib/github_api/utils/url.rb
+- lib/github_api/validations.rb
 - lib/github_api/validations/format.rb
 - lib/github_api/validations/presence.rb
 - lib/github_api/validations/required.rb
 - lib/github_api/validations/token.rb
-- lib/github_api/validations.rb
 - lib/github_api/version.rb
-- lib/github_api.rb
-- LICENSE.txt
-- README.md
 homepage: http://piotrmurach.github.io/github/
 licenses:
 - MIT
@@ -263,17 +264,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the official GitHub API